src/modules/m_ircv3_sts.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2017-2019 Sadie Powell <sadie@witchery.services>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #include "inspircd.h"
  21 #include "modules/cap.h"
  22 #include "modules/ssl.h"
  23
  24 class STSCap : public Cap::Capability
  25 {
  26  private:
  27         std::string host;
  28         std::string plaintextpolicy;
  29         std::string securepolicy;
  30
  31         bool OnList(LocalUser* user) CXX11_OVERRIDE
  32         {
  33                 // Don't send the cap to clients that only support cap-3.1.
  34                 if (GetProtocol(user) == Cap::CAP_LEGACY)
  35                         return false;
  36
  37                 // Don't send the cap to clients in a class which has STS disabled.
  38                 if (!user->GetClass()->config->getBool("usests", true))
  39                         return false;
  40
  41                 // Plaintext listeners have their own policy.
  42                 SSLIOHook* sslhook = SSLIOHook::IsSSL(&user->eh);
  43                 if (!sslhook)
  44                         return true;
  45
  46                 // If no hostname has been provided for the connection, an STS persistence policy SHOULD NOT be advertised.
  47                 std::string snihost;
  48                 if (!sslhook->GetServerName(snihost))
  49                         return false;
  50
  51                 // Before advertising an STS persistence policy over a secure connection, servers SHOULD verify whether the
  52                 // hostname provided by clients, for example, via TLS Server Name Indication (SNI), has been whitelisted by
  53                 // administrators in the server configuration.
  54                 return InspIRCd::Match(snihost, host, ascii_case_insensitive_map);
  55         }
  56
  57         bool OnRequest(LocalUser* user, bool adding) CXX11_OVERRIDE
  58         {
  59                 // Clients MUST NOT request this capability with CAP REQ. Servers MAY reply with a CAP NAK message if a
  60                 // client requests this capability.
  61                 return false;
  62         }
  63
  64         const std::string* GetValue(LocalUser* user) const CXX11_OVERRIDE
  65         {
  66                 return SSLIOHook::IsSSL(&user->eh) ? &securepolicy : &plaintextpolicy;
  67         }
  68
  69  public:
  70         STSCap(Module* mod)
  71                 : Cap::Capability(mod, "sts")
  72         {
  73                 DisableAutoRegister();
  74         }
  75
  76         ~STSCap()
  77         {
  78                 // TODO: Send duration=0 when STS vanishes.
  79         }
  80
  81         void SetPolicy(const std::string& newhost, unsigned long duration, unsigned int port, bool preload)
  82         {
  83                 // To enforce an STS upgrade policy, servers MUST send this key to insecurely connected clients. Servers
  84                 // MAY send this key to securely connected clients, but it will be ignored.
  85                 std::string newplaintextpolicy("port=");
  86                 newplaintextpolicy.append(ConvToStr(port));
  87
  88                 // To enforce an STS persistence policy, servers MUST send this key to securely connected clients. Servers
  89                 // MAY send this key to all clients, but insecurely connected clients MUST ignore it.
  90                 std::string newsecurepolicy("duration=");
  91                 newsecurepolicy.append(ConvToStr(duration));
  92
  93                 // Servers MAY send this key to all clients, but insecurely connected clients MUST ignore it.
  94                 if (preload)
  95                         newsecurepolicy.append(",preload");
  96
  97                 // Apply the new policy.
  98                 bool changed = false;
  99                 if (!irc::equals(host, newhost))
 100                 {
 101                         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Changing STS SNI hostname from \"%s\" to \"%s\"", host.c_str(), newhost.c_str());
 102                         host = newhost;
 103                         changed = true;
 104                 }
 105
 106                 if (plaintextpolicy != newplaintextpolicy)
 107                 {
 108                         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Changing plaintext STS policy from \"%s\" to \"%s\"", plaintextpolicy.c_str(), newplaintextpolicy.c_str());
 109                         plaintextpolicy.swap(newplaintextpolicy);
 110                         changed = true;
 111                 }
 112
 113                 if (securepolicy != newsecurepolicy)
 114                 {
 115                         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Changing secure STS policy from \"%s\" to \"%s\"", securepolicy.c_str(), newsecurepolicy.c_str());
 116                         securepolicy.swap(newsecurepolicy);
 117                         changed = true;
 118                 }
 119
 120                 // If the policy has changed then notify all clients via cap-notify.
 121                 if (changed)
 122                         NotifyValueChange();
 123         }
 124 };
 125
 126 class ModuleIRCv3STS : public Module
 127 {
 128  private:
 129         STSCap cap;
 130
 131         // The IRCv3 STS specification requires that the server is listening using SSL using a valid certificate.
 132         bool HasValidSSLPort(unsigned int port)
 133         {
 134                 for (std::vector<ListenSocket*>::const_iterator iter = ServerInstance->ports.begin(); iter != ServerInstance->ports.end(); ++iter)
 135                 {
 136                         ListenSocket* ls = *iter;
 137
 138                         // Is this listener on the right port?
 139                         unsigned int saport = ls->bind_sa.port();
 140                         if (saport != port)
 141                                 continue;
 142
 143                         // Is this listener using SSL?
 144                         if (ls->bind_tag->getString("ssl").empty())
 145                                 continue;
 146
 147                         // TODO: Add a way to check if a listener's TLS cert is CA-verified.
 148                         return true;
 149                 }
 150                 return false;
 151         }
 152
 153  public:
 154         ModuleIRCv3STS()
 155                 : cap(this)
 156         {
 157         }
 158
 159         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 160         {
 161                 // TODO: Multiple SNI profiles
 162                 ConfigTag* tag = ServerInstance->Config->ConfValue("sts");
 163                 if (tag == ServerInstance->Config->EmptyTag)
 164                         throw ModuleException("You must define a STS policy!");
 165
 166                 const std::string host = tag->getString("host");
 167                 if (host.empty())
 168                         throw ModuleException("<sts:host> must contain a hostname, at " + tag->getTagLocation());
 169
 170                 unsigned int port = tag->getUInt("port", 0, 0, UINT16_MAX);
 171                 if (!HasValidSSLPort(port))
 172                         throw ModuleException("<sts:port> must be a TLS port, at " + tag->getTagLocation());
 173
 174                 unsigned long duration = tag->getDuration("duration", 5*60, 60);
 175                 bool preload = tag->getBool("preload");
 176                 cap.SetPolicy(host, duration, port, preload);
 177
 178                 if (!cap.IsRegistered())
 179                         ServerInstance->Modules->AddService(cap);
 180         }
 181
 182         Version GetVersion() CXX11_OVERRIDE
 183         {
 184                 return Version("Provides IRCv3 Strict Transport Security policy advertisement", VF_OPTCOMMON|VF_VENDOR);
 185         }
 186 };
 187
 188 MODULE_INIT(ModuleIRCv3STS)