src/modules/m_sslinfo.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   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>
  14  *
  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.
  18  *
  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
  22  * details.
  23  *
  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/>.
  26  */
  27
  28
  29 #include "inspircd.h"
  30 #include "modules/ssl.h"
  31 #include "modules/webirc.h"
  32 #include "modules/whois.h"
  33 #include "modules/who.h"
  34
  35 enum
  36 {
  37         // From oftc-hybrid.
  38         RPL_WHOISCERTFP = 276,
  39
  40         // From UnrealIRCd.
  41         RPL_WHOISSECURE = 671
  42 };
  43
  44 class SSLCertExt : public ExtensionItem
  45 {
  46  public:
  47         SSLCertExt(Module* parent)
  48                 : ExtensionItem("ssl_cert", ExtensionItem::EXT_USER, parent)
  49         {
  50         }
  51
  52         ssl_cert* get(const Extensible* item) const
  53         {
  54                 return static_cast<ssl_cert*>(get_raw(item));
  55         }
  56
  57         void set(Extensible* item, ssl_cert* value)
  58         {
  59                 value->refcount_inc();
  60                 ssl_cert* old = static_cast<ssl_cert*>(set_raw(item, value));
  61                 if (old && old->refcount_dec())
  62                         delete old;
  63         }
  64
  65         void unset(Extensible* container)
  66         {
  67                 free(container, unset_raw(container));
  68         }
  69
  70         std::string ToNetwork(const Extensible* container, void* item) const CXX11_OVERRIDE
  71         {
  72                 return static_cast<ssl_cert*>(item)->GetMetaLine();
  73         }
  74
  75         void FromNetwork(Extensible* container, const std::string& value) CXX11_OVERRIDE
  76         {
  77                 ssl_cert* cert = new ssl_cert;
  78                 set(container, cert);
  79
  80                 std::stringstream s(value);
  81                 std::string v;
  82                 getline(s,v,' ');
  83
  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)
  89                 {
  90                         getline(s,cert->error,'\n');
  91                 }
  92                 else
  93                 {
  94                         getline(s,cert->fingerprint,' ');
  95                         getline(s,cert->dn,' ');
  96                         getline(s,cert->issuer,'\n');
  97                 }
  98         }
  99
 100         void free(Extensible* container, void* item) CXX11_OVERRIDE
 101         {
 102                 ssl_cert* old = static_cast<ssl_cert*>(item);
 103                 if (old && old->refcount_dec())
 104                         delete old;
 105         }
 106 };
 107
 108 class UserCertificateAPIImpl : public UserCertificateAPIBase
 109 {
 110  public:
 111         LocalIntExt nosslext;
 112         SSLCertExt sslext;
 113
 114         UserCertificateAPIImpl(Module* mod)
 115                 : UserCertificateAPIBase(mod)
 116                 , nosslext("no_ssl_cert", ExtensionItem::EXT_USER, mod)
 117                 , sslext(mod)
 118         {
 119         }
 120
 121         ssl_cert* GetCertificate(User* user) CXX11_OVERRIDE
 122         {
 123                 ssl_cert* cert = sslext.get(user);
 124                 if (cert)
 125                         return cert;
 126
 127                 LocalUser* luser = IS_LOCAL(user);
 128                 if (!luser || nosslext.get(luser))
 129                         return NULL;
 130
 131                 cert = SSLClientCert::GetCertificate(&luser->eh);
 132                 if (!cert)
 133                         return NULL;
 134
 135                 SetCertificate(user, cert);
 136                 return cert;
 137         }
 138
 139         void SetCertificate(User* user, ssl_cert* cert) CXX11_OVERRIDE
 140         {
 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);
 144         }
 145 };
 146
 147 class CommandSSLInfo : public Command
 148 {
 149  public:
 150         UserCertificateAPIImpl sslapi;
 151
 152         CommandSSLInfo(Module* Creator)
 153                 : Command(Creator, "SSLINFO", 1)
 154                 , sslapi(Creator)
 155         {
 156                 syntax = "<nick>";
 157         }
 158
 159         CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
 160         {
 161                 User* target = ServerInstance->FindNickOnly(parameters[0]);
 162
 163                 if ((!target) || (target->registered != REG_ALL))
 164                 {
 165                         user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
 166                         return CMD_FAILURE;
 167                 }
 168
 169                 bool operonlyfp = ServerInstance->Config->ConfValue("sslinfo")->getBool("operonly");
 170                 if (operonlyfp && !user->IsOper() && target != user)
 171                 {
 172                         user->WriteNotice("*** You cannot view TLS (SSL) client certificate information for other users");
 173                         return CMD_FAILURE;
 174                 }
 175
 176                 ssl_cert* cert = sslapi.GetCertificate(target);
 177                 if (!cert)
 178                 {
 179                         user->WriteNotice("*** No TLS (SSL) client certificate for this user");
 180                 }
 181                 else if (cert->GetError().length())
 182                 {
 183                         user->WriteNotice("*** No TLS (SSL) client certificate information for this user (" + cert->GetError() + ").");
 184                 }
 185                 else
 186                 {
 187                         user->WriteNotice("*** Distinguished Name: " + cert->GetDN());
 188                         user->WriteNotice("*** Issuer:             " + cert->GetIssuer());
 189                         user->WriteNotice("*** Key Fingerprint:    " + cert->GetFingerprint());
 190                 }
 191
 192                 return CMD_SUCCESS;
 193         }
 194 };
 195
 196 class ModuleSSLInfo
 197         : public Module
 198         , public WebIRC::EventListener
 199         , public Whois::EventListener
 200         , public Who::EventListener
 201 {
 202  private:
 203         CommandSSLInfo cmd;
 204
 205         bool MatchFP(ssl_cert* const cert, const std::string& fp) const
 206         {
 207                 return irc::spacesepstream(fp).Contains(cert->GetFingerprint());
 208         }
 209
 210  public:
 211         ModuleSSLInfo()
 212                 : WebIRC::EventListener(this)
 213                 , Whois::EventListener(this)
 214                 , Who::EventListener(this)
 215                 , cmd(this)
 216         {
 217         }
 218
 219         Version GetVersion() CXX11_OVERRIDE
 220         {
 221                 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);
 222         }
 223
 224         void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
 225         {
 226                 ssl_cert* cert = cmd.sslapi.GetCertificate(whois.GetTarget());
 227                 if (cert)
 228                 {
 229                         whois.SendLine(RPL_WHOISSECURE, "is using a secure connection");
 230                         bool operonlyfp = ServerInstance->Config->ConfValue("sslinfo")->getBool("operonly");
 231                         if ((!operonlyfp || whois.IsSelfWhois() || whois.GetSource()->IsOper()) && !cert->fingerprint.empty())
 232                                 whois.SendLine(RPL_WHOISCERTFP, InspIRCd::Format("has TLS (SSL) client certificate fingerprint %s", cert->fingerprint.c_str()));
 233                 }
 234         }
 235
 236         ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) CXX11_OVERRIDE
 237         {
 238                 size_t flag_index;
 239                 if (!request.GetFieldIndex('f', flag_index))
 240                         return MOD_RES_PASSTHRU;
 241
 242                 ssl_cert* cert = cmd.sslapi.GetCertificate(user);
 243                 if (cert)
 244                         numeric.GetParams()[flag_index].push_back('s');
 245
 246                 return MOD_RES_PASSTHRU;
 247         }
 248
 249         ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
 250         {
 251                 if ((command == "OPER") && (validated))
 252                 {
 253                         ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.find(parameters[0]);
 254                         if (i != ServerInstance->Config->oper_blocks.end())
 255                         {
 256                                 OperInfo* ifo = i->second;
 257                                 ssl_cert* cert = cmd.sslapi.GetCertificate(user);
 258
 259                                 if (ifo->oper_block->getBool("sslonly") && !cert)
 260                                 {
 261                                         user->WriteNumeric(ERR_NOOPERHOST, "Invalid oper credentials");
 262                                         user->CommandFloodPenalty += 10000;
 263                                         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());
 264                                         return MOD_RES_DENY;
 265                                 }
 266
 267                                 std::string fingerprint;
 268                                 if (ifo->oper_block->readString("fingerprint", fingerprint) && (!cert || !MatchFP(cert, fingerprint)))
 269                                 {
 270                                         user->WriteNumeric(ERR_NOOPERHOST, "Invalid oper credentials");
 271                                         user->CommandFloodPenalty += 10000;
 272                                         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());
 273                                         return MOD_RES_DENY;
 274                                 }
 275                         }
 276                 }
 277
 278                 // Let core handle it for extra stuff
 279                 return MOD_RES_PASSTHRU;
 280         }
 281
 282         void OnPostConnect(User* user) CXX11_OVERRIDE
 283         {
 284                 LocalUser* const localuser = IS_LOCAL(user);
 285                 if (!localuser)
 286                         return;
 287
 288                 const SSLIOHook* const ssliohook = SSLIOHook::IsSSL(&localuser->eh);
 289                 if (!ssliohook || cmd.sslapi.nosslext.get(localuser))
 290                         return;
 291
 292                 ssl_cert* const cert = ssliohook->GetCertificate();
 293
 294                 std::string text = "*** You are connected to ";
 295                 if (!ssliohook->GetServerName(text))
 296                         text.append(ServerInstance->Config->ServerName);
 297                 text.append(" using TLS (SSL) cipher '");
 298                 ssliohook->GetCiphersuite(text);
 299                 text.push_back('\'');
 300                 if (cert && !cert->GetFingerprint().empty())
 301                         text.append(" and your TLS (SSL) client certificate fingerprint is ").append(cert->GetFingerprint());
 302                 user->WriteNotice(text);
 303
 304                 if (!cert)
 305                         return;
 306
 307                 // Find an auto-oper block for this user
 308                 for (ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.begin(); i != ServerInstance->Config->oper_blocks.end(); ++i)
 309                 {
 310                         OperInfo* ifo = i->second;
 311                         std::string fp = ifo->oper_block->getString("fingerprint");
 312                         if (MatchFP(cert, fp) && ifo->oper_block->getBool("autologin"))
 313                                 user->Oper(ifo);
 314                 }
 315         }
 316
 317         ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
 318         {
 319                 ssl_cert* cert = cmd.sslapi.GetCertificate(user);
 320                 bool ok = true;
 321                 const std::string requiressl = myclass->config->getString("requiressl");
 322                 if (stdalgo::string::equalsci(requiressl, "trusted"))
 323                 {
 324                         ok = (cert && cert->IsCAVerified());
 325                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class requires a trusted TLS (SSL) client certificate. Client %s one.", (ok ? "has" : "does not have"));
 326                 }
 327                 else if (myclass->config->getBool("requiressl"))
 328                 {
 329                         ok = (cert != NULL);
 330                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class requires a secure connection. Client %s on a secure connection.", (ok ? "is" : "is not"));
 331                 }
 332
 333                 if (!ok)
 334                         return MOD_RES_DENY;
 335
 336                 return MOD_RES_PASSTHRU;
 337         }
 338
 339         void OnWebIRCAuth(LocalUser* user, const WebIRC::FlagMap* flags) CXX11_OVERRIDE
 340         {
 341                 // We are only interested in connection flags. If none have been
 342                 // given then we have nothing to do.
 343                 if (!flags)
 344                         return;
 345
 346                 // We only care about the tls connection flag if the connection
 347                 // between the gateway and the server is secure.
 348                 if (!cmd.sslapi.GetCertificate(user))
 349                         return;
 350
 351                 WebIRC::FlagMap::const_iterator iter = flags->find("secure");
 352                 if (iter == flags->end())
 353                 {
 354                         // If this is not set then the connection between the client and
 355                         // the gateway is not secure.
 356                         cmd.sslapi.nosslext.set(user, 1);
 357                         cmd.sslapi.sslext.unset(user);
 358                         return;
 359                 }
 360
 361                 // Create a fake ssl_cert for the user.
 362                 ssl_cert* cert = new ssl_cert;
 363                 cert->error = "WebIRC users can not specify valid certs yet";
 364                 cert->invalid = true;
 365                 cert->revoked = true;
 366                 cert->trusted = false;
 367                 cert->unknownsigner = true;
 368                 cmd.sslapi.SetCertificate(user, cert);
 369         }
 370 };
 371
 372 MODULE_INIT(ModuleSSLInfo)