2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2017-2019 Sadie Powell <sadie@witchery.services>
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.
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
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/>.
21 #include "modules/cap.h"
22 #include "modules/ssl.h"
24 class STSCap : public Cap::Capability
28 std::string plaintextpolicy;
29 std::string securepolicy;
31 bool OnList(LocalUser* user) CXX11_OVERRIDE
33 // Don't send the cap to clients that only support cap-3.1.
34 if (GetProtocol(user) == Cap::CAP_LEGACY)
37 // Don't send the cap to clients in a class which has STS disabled.
38 if (!user->GetClass()->config->getBool("usests", true))
41 // Plaintext listeners have their own policy.
42 SSLIOHook* sslhook = SSLIOHook::IsSSL(&user->eh);
46 // If no hostname has been provided for the connection, an STS persistence policy SHOULD NOT be advertised.
48 if (!sslhook->GetServerName(snihost))
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);
57 bool OnRequest(LocalUser* user, bool adding) CXX11_OVERRIDE
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.
64 const std::string* GetValue(LocalUser* user) const CXX11_OVERRIDE
66 return SSLIOHook::IsSSL(&user->eh) ? &securepolicy : &plaintextpolicy;
71 : Cap::Capability(mod, "sts")
77 // TODO: Send duration=0 when STS vanishes.
80 void SetPolicy(const std::string& newhost, unsigned long duration, unsigned int port, bool preload)
82 // To enforce an STS upgrade policy, servers MUST send this key to insecurely connected clients. Servers
83 // MAY send this key to securely connected clients, but it will be ignored.
84 std::string newplaintextpolicy("port=");
85 newplaintextpolicy.append(ConvToStr(port));
87 // To enforce an STS persistence policy, servers MUST send this key to securely connected clients. Servers
88 // MAY send this key to all clients, but insecurely connected clients MUST ignore it.
89 std::string newsecurepolicy("duration=");
90 newsecurepolicy.append(ConvToStr(duration));
92 // Servers MAY send this key to all clients, but insecurely connected clients MUST ignore it.
94 newsecurepolicy.append(",preload");
96 // Apply the new policy.
98 if (!irc::equals(host, newhost))
100 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Changing STS SNI hostname from \"%s\" to \"%s\"", host.c_str(), newhost.c_str());
105 if (plaintextpolicy != newplaintextpolicy)
107 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Changing plaintext STS policy from \"%s\" to \"%s\"", plaintextpolicy.c_str(), newplaintextpolicy.c_str());
108 plaintextpolicy.swap(newplaintextpolicy);
112 if (securepolicy != newsecurepolicy)
114 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Changing secure STS policy from \"%s\" to \"%s\"", securepolicy.c_str(), newsecurepolicy.c_str());
115 securepolicy.swap(newsecurepolicy);
119 // If the policy has changed then notify all clients via cap-notify.
125 class ModuleIRCv3STS : public Module
130 // The IRCv3 STS specification requires that the server is listening using SSL using a valid certificate.
131 bool HasValidSSLPort(unsigned int port)
133 for (std::vector<ListenSocket*>::const_iterator iter = ServerInstance->ports.begin(); iter != ServerInstance->ports.end(); ++iter)
135 ListenSocket* ls = *iter;
137 // Is this listener on the right port?
138 unsigned int saport = ls->bind_sa.port();
142 // Is this listener using SSL?
143 if (ls->bind_tag->getString("ssl").empty())
146 // TODO: Add a way to check if a listener's TLS cert is CA-verified.
158 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
160 // TODO: Multiple SNI profiles
161 ConfigTag* tag = ServerInstance->Config->ConfValue("sts");
162 if (tag == ServerInstance->Config->EmptyTag)
163 throw ModuleException("You must define a STS policy!");
165 const std::string host = tag->getString("host");
167 throw ModuleException("<sts:host> must contain a hostname, at " + tag->getTagLocation());
169 unsigned int port = tag->getUInt("port", 0, 0, UINT16_MAX);
170 if (!HasValidSSLPort(port))
171 throw ModuleException("<sts:port> must be a TLS port, at " + tag->getTagLocation());
173 unsigned long duration = tag->getDuration("duration", 60*60*24*30*2);
174 bool preload = tag->getBool("preload");
175 cap.SetPolicy(host, duration, port, preload);
178 Version GetVersion() CXX11_OVERRIDE
180 return Version("Provides IRCv3 Strict Transport Security policy advertisement", VF_OPTCOMMON|VF_VENDOR);
184 MODULE_INIT(ModuleIRCv3STS)