#include "inspircd.h"
-#include "xline.h"
-#include "modules/dns.h"
+#include "modules/ssl.h"
+#include "modules/webirc.h"
+#include "modules/whois.h"
-// We need this method up here so that it can be accessed from anywhere
-static void ChangeIP(User* user, const std::string& newip)
+enum
{
- ServerInstance->Users->RemoveCloneCounts(user);
- user->SetClientIP(newip.c_str());
- ServerInstance->Users->AddClone(user);
-}
+ // InspIRCd-specific.
+ RPL_WHOISGATEWAY = 350
+};
+
+// Encapsulates information about an ident host.
+class IdentHost
+{
+ private:
+ std::string hostmask;
+ std::string newident;
+
+ public:
+ IdentHost(const std::string& mask, const std::string& ident)
+ : hostmask(mask)
+ , newident(ident)
+ {
+ }
+
+ const std::string& GetIdent() const
+ {
+ return newident;
+ }
+
+ bool Matches(LocalUser* user) const
+ {
+ if (!InspIRCd::Match(user->GetRealHost(), hostmask, ascii_case_insensitive_map))
+ return false;
+
+ return InspIRCd::MatchCIDR(user->GetIPString(), hostmask, ascii_case_insensitive_map);
+ }
+};
// Encapsulates information about a WebIRC host.
class WebIRCHost
{
private:
- const std::string hostmask;
- const std::string password;
+ std::string hostmask;
+ std::string fingerprint;
+ std::string password;
+ std::string passhash;
public:
- WebIRCHost(const std::string& mask, const std::string& pass)
+ WebIRCHost(const std::string& mask, const std::string& fp, const std::string& pass, const std::string& hash)
: hostmask(mask)
+ , fingerprint(fp)
, password(pass)
+ , passhash(hash)
{
}
- bool Matches(LocalUser* user, const std::string& pass) const
+ bool Matches(LocalUser* user, const std::string& pass, UserCertificateAPI& sslapi) const
{
// Did the user send a valid password?
- if (!InspIRCd::TimingSafeCompare(password, pass))
+ if (!password.empty() && !ServerInstance->PassCompare(user, password, pass, passhash))
+ return false;
+
+ // Does the user have a valid fingerprint?
+ const std::string fp = sslapi ? sslapi->GetFingerprint(user) : "";
+ if (!fingerprint.empty() && !InspIRCd::TimingSafeCompare(fp, fingerprint))
return false;
// Does the user's hostname match our hostmask?
- if (InspIRCd::Match(user->host, hostmask, ascii_case_insensitive_map))
+ if (InspIRCd::Match(user->GetRealHost(), hostmask, ascii_case_insensitive_map))
return true;
// Does the user's IP address match our hostmask?
StringExtItem gateway;
StringExtItem realhost;
StringExtItem realip;
+ UserCertificateAPI sslapi;
+ Events::ModuleEventProvider webircevprov;
CommandWebIRC(Module* Creator)
: SplitCommand(Creator, "WEBIRC", 4)
, gateway("cgiirc_gateway", ExtensionItem::EXT_USER, Creator)
, realhost("cgiirc_realhost", ExtensionItem::EXT_USER, Creator)
, realip("cgiirc_realip", ExtensionItem::EXT_USER, Creator)
+ , sslapi(Creator)
+ , webircevprov(Creator, "event/webirc")
+ {
+ allow_empty_last_param = false;
+ works_before_reg = true;
+ this->syntax = "<password> <gateway> <hostname> <ip> [flags]";
+ }
+
+ CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
+ {
+ if (user->registered == REG_ALL || realhost.get(user))
+ return CMD_FAILURE;
+
+ for (std::vector<WebIRCHost>::const_iterator iter = hosts.begin(); iter != hosts.end(); ++iter)
{
- allow_empty_last_param = false;
- works_before_reg = true;
- this->syntax = "password gateway hostname ip";
- }
- CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user)
- {
- if(user->registered == REG_ALL)
- return CMD_FAILURE;
+ // If we don't match the host then skip to the next host.
+ if (!iter->Matches(user, parameters[0], sslapi))
+ continue;
irc::sockets::sockaddrs ipaddr;
- if (!irc::sockets::aptosa(parameters[3], 0, ipaddr))
+ if (!irc::sockets::aptosa(parameters[3], user->client_sa.port(), ipaddr))
{
- user->CommandFloodPenalty += 5000;
- ServerInstance->SNO->WriteGlobalSno('a', "Connecting user %s tried to use WEBIRC but gave an invalid IP address.", user->GetFullRealHost().c_str());
+ WriteLog("Connecting user %s (%s) tried to use WEBIRC but gave an invalid IP address.",
+ user->uuid.c_str(), user->GetIPString().c_str());
+ ServerInstance->Users->QuitUser(user, "WEBIRC: IP address is invalid: " + parameters[3]);
return CMD_FAILURE;
}
- for (std::vector<WebIRCHost>::const_iterator iter = hosts.begin(); iter != hosts.end(); ++iter)
- {
- // If we don't match the host then skip to the next host.
- if (!iter->Matches(user, parameters[0]))
- continue;
+ // The user matched a WebIRC block!
+ gateway.set(user, parameters[1]);
+ realhost.set(user, user->GetRealHost());
+ realip.set(user, user->GetIPString());
+
+ WriteLog("Connecting user %s is using a WebIRC gateway; changing their IP from %s to %s.",
+ user->uuid.c_str(), user->GetIPString().c_str(), parameters[3].c_str());
+ // If we have custom flags then deal with them.
+ WebIRC::FlagMap flags;
+ const bool hasflags = (parameters.size() > 4);
+ if (hasflags)
+ {
+ // Parse the flags.
+ irc::spacesepstream flagstream(parameters[4]);
+ for (std::string flag; flagstream.GetToken(flag); )
{
+ // Does this flag have a value?
+ const size_t separator = flag.find('=');
+ if (separator == std::string::npos)
{
- gateway.set(user, parameters[1]);
- realhost.set(user, user->host);
- realip.set(user, user->GetIPString());
-
- // Check if we're happy with the provided hostname. If it's problematic then make sure we won't set a host later, just the IP
- bool host_ok = (parameters[2].length() <= ServerInstance->Config->Limits.MaxHost) && (parameters[2].find_first_not_of("0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-") == std::string::npos);
- const std::string& newhost = (host_ok ? parameters[2] : parameters[3]);
-
- if (notify)
- ServerInstance->SNO->WriteGlobalSno('w', "Connecting user %s detected as using CGI:IRC (%s), changing real host to %s from %s", user->nick.c_str(), user->host.c_str(), newhost.c_str(), user->host.c_str());
-
- // Where the magic happens - change their IP
- ChangeIP(user, parameters[3]);
- // And follow this up by changing their host
- user->host = user->dhost = newhost;
- user->InvalidateCache();
-
- return CMD_SUCCESS;
+ flags[flag];
+ continue;
}
+
+ // The flag has a value!
+ const std::string key = flag.substr(0, separator);
+ const std::string value = flag.substr(separator + 1);
+ flags[key] = value;
}
}
- user->CommandFloodPenalty += 5000;
- ServerInstance->SNO->WriteGlobalSno('w', "Connecting user %s tried to use WEBIRC, but didn't match any configured webirc blocks.", user->GetFullRealHost().c_str());
- return CMD_FAILURE;
- }
-};
-
-
-/** Resolver for CGI:IRC hostnames encoded in ident/GECOS
- */
-class CGIResolver : public DNS::Request
-{
- std::string theiruid;
- LocalIntExt& waiting;
- bool notify;
- public:
- CGIResolver(DNS::Manager* mgr, Module* me, bool NotifyOpers, const std::string &source, LocalUser* u, LocalIntExt& ext)
- : DNS::Request(mgr, me, source, DNS::QUERY_PTR)
- , theiruid(u->uuid)
- , waiting(ext)
- , notify(NotifyOpers)
- {
- }
+ // Inform modules about the WebIRC attempt.
+ FOREACH_MOD_CUSTOM(webircevprov, WebIRC::EventListener, OnWebIRCAuth, (user, (hasflags ? &flags : NULL)));
- void OnLookupComplete(const DNS::Query *r) CXX11_OVERRIDE
- {
- /* Check the user still exists */
- User* them = ServerInstance->FindUUID(theiruid);
- if ((them) && (!them->quitting))
- {
- LocalUser* lu = IS_LOCAL(them);
- if (!lu)
- return;
-
- const DNS::ResourceRecord &ans_record = r->answers[0];
- if (ans_record.rdata.empty() || ans_record.rdata.length() > ServerInstance->Config->Limits.MaxHost)
- return;
-
- if (notify)
- ServerInstance->SNO->WriteGlobalSno('w', "Connecting user %s detected as using CGI:IRC (%s), changing real host to %s", them->nick.c_str(), them->host.c_str(), ans_record.rdata.c_str());
-
- them->host = them->dhost = ans_record.rdata;
- them->InvalidateCache();
- lu->CheckLines(true);
+ // Set the IP address sent via WEBIRC. We ignore the hostname and lookup
+ // instead do our own DNS lookups because of unreliable gateways.
+ user->SetClientIP(ipaddr);
+ return CMD_SUCCESS;
}
- }
-
- void OnError(const DNS::Query *r) CXX11_OVERRIDE
- {
- if (!notify)
- return;
- User* them = ServerInstance->FindUUID(theiruid);
- if ((them) && (!them->quitting))
- {
- ServerInstance->SNO->WriteToSnoMask('w', "Connecting user %s detected as using CGI:IRC (%s), but their host can't be resolved!", them->nick.c_str(), them->host.c_str());
- }
+ WriteLog("Connecting user %s (%s) tried to use WEBIRC but didn't match any configured WebIRC hosts.",
+ user->uuid.c_str(), user->GetIPString().c_str());
+ ServerInstance->Users->QuitUser(user, "WEBIRC: you don't match any configured WebIRC hosts.");
+ return CMD_FAILURE;
}
- ~CGIResolver()
+ void WriteLog(const char* message, ...) CUSTOM_PRINTF(2, 3)
{
- User* them = ServerInstance->FindUUID(theiruid);
- if (!them)
- return;
- int count = waiting.get(them);
- if (count)
- waiting.set(them, count - 1);
+ std::string buffer;
+ VAFORMAT(buffer, message, message);
+
+ // If we are sending a snotice then the message will already be
+ // written to the logfile.
+ if (notify)
+ ServerInstance->SNO->WriteGlobalSno('w', buffer);
+ else
+ ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, buffer);
}
};
-class ModuleCgiIRC : public Module
+class ModuleCgiIRC
+ : public Module
+ , public WebIRC::EventListener
+ , public Whois::EventListener
{
+ private:
CommandWebIRC cmd;
- LocalIntExt waiting;
- dynamic_reference<DNS::Manager> DNS;
- std::vector<std::string> hosts;
+ std::vector<IdentHost> hosts;
- static void RecheckClass(LocalUser* user)
+ static bool ParseIdent(LocalUser* user, irc::sockets::sockaddrs& out)
{
- user->MyClass = NULL;
- user->SetClass();
- user->CheckClass();
- }
-
- void HandleIdent(LocalUser* user, const std::string& newip)
- {
- cmd.realhost.set(user, user->host);
- cmd.realip.set(user, user->GetIPString());
- ChangeIP(user, newip);
- user->host = user->dhost = user->GetIPString();
- user->InvalidateCache();
- RecheckClass(user);
-
- // Don't create the resolver if the core couldn't put the user in a connect class or when dns is disabled
- if (user->quitting || !DNS || !user->MyClass->resolvehostnames)
- return;
-
- CGIResolver* r = new CGIResolver(*this->DNS, this, cmd.notify, newip, user, waiting);
- try
+ const char* ident = NULL;
+ if (user->ident.length() == 8)
{
- waiting.set(user, waiting.get(user) + 1);
- this->DNS->Process(r);
+ // The ident is an IPv4 address encoded in hexadecimal with two characters
+ // per address segment.
+ ident = user->ident.c_str();
}
- catch (DNS::Exception &ex)
+ else if (user->ident.length() == 9 && user->ident[0] == '~')
{
- int count = waiting.get(user);
- if (count)
- waiting.set(user, count - 1);
- delete r;
- if (cmd.notify)
- ServerInstance->SNO->WriteToSnoMask('w', "Connecting user %s detected as using CGI:IRC (%s), but I could not resolve their hostname; %s", user->nick.c_str(), user->host.c_str(), ex.GetReason().c_str());
+ // The same as above but m_ident got to this user before we did. Strip the
+ // ident prefix and continue as normal.
+ ident = user->ident.c_str() + 1;
}
+ else
+ {
+ // The user either does not have an IPv4 in their ident or the gateway server
+ // is also running an identd. In the latter case there isn't really a lot we
+ // can do so we just assume that the client in question is not connecting via
+ // an ident gateway.
+ return false;
+ }
+
+ // Try to convert the IP address to a string. If this fails then the user
+ // does not have an IPv4 address in their ident.
+ errno = 0;
+ unsigned long address = strtoul(ident, NULL, 16);
+ if (errno)
+ return false;
+
+ out.in4.sin_family = AF_INET;
+ out.in4.sin_addr.s_addr = htonl(address);
+ return true;
}
-public:
+ public:
ModuleCgiIRC()
- : cmd(this)
- , waiting("cgiirc-delay", ExtensionItem::EXT_USER, this)
- , DNS(this, "DNS")
+ : WebIRC::EventListener(this)
+ , Whois::EventListener(this)
+ , cmd(this)
{
}
void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- std::vector<std::string> identhosts;
+ std::vector<IdentHost> identhosts;
std::vector<WebIRCHost> webirchosts;
ConfigTagList tags = ServerInstance->Config->ConfTags("cgihost");
if (stdalgo::string::equalsci(type, "ident"))
{
// The IP address should be looked up from the hex IP address.
- identhosts.push_back(mask);
+ const std::string newident = tag->getString("newident", "gateway", ServerInstance->IsIdent);
+ identhosts.push_back(IdentHost(mask, newident));
}
else if (stdalgo::string::equalsci(type, "webirc"))
{
// The IP address will be received via the WEBIRC command.
+ const std::string fingerprint = tag->getString("fingerprint");
const std::string password = tag->getString("password");
// WebIRC blocks require a password.
- if (password.empty())
- throw ModuleException("When using <cgihost type=\"webirc\"> the password field is required, at " + tag->getTagLocation());
+ if (fingerprint.empty() && password.empty())
+ throw ModuleException("When using <cgihost type=\"webirc\"> either the fingerprint or password field is required, at " + tag->getTagLocation());
- webirchosts.push_back(WebIRCHost(mask, password));
+ webirchosts.push_back(WebIRCHost(mask, fingerprint, password, tag->getString("hash")));
}
else
{
- throw ModuleException(type + " is an invalid <cgihost:mask> type, at " + tag->getTagLocation());
+ throw ModuleException(type + " is an invalid <cgihost:mask> type, at " + tag->getTagLocation());
}
}
hosts.swap(identhosts);
cmd.hosts.swap(webirchosts);
- // Do we send an oper notice when a m_cgiirc client has their IP/host changed?
+ // Do we send an oper notice when a m_cgiirc client has their IP changed?
cmd.notify = ServerInstance->Config->ConfValue("cgiirc")->getBool("opernotice", true);
}
- ModResult OnCheckReady(LocalUser *user) CXX11_OVERRIDE
- {
- if (waiting.get(user))
- return MOD_RES_DENY;
-
- if (!cmd.realip.get(user))
- return MOD_RES_PASSTHRU;
-
- RecheckClass(user);
- if (user->quitting)
- return MOD_RES_DENY;
-
- user->CheckLines(true);
- if (user->quitting)
- return MOD_RES_DENY;
-
- return MOD_RES_PASSTHRU;
- }
-
ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
{
// If <connect:webirc> is not set then we have nothing to do.
ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
{
- for (std::vector<std::string>::const_iterator iter = hosts.begin(); iter != hosts.end(); ++iter)
+ // There is no need to check for gateways if one is already being used.
+ if (cmd.realhost.get(user))
+ return MOD_RES_PASSTHRU;
+
+ for (std::vector<IdentHost>::const_iterator iter = hosts.begin(); iter != hosts.end(); ++iter)
{
- if (!InspIRCd::Match(user->host, *iter, ascii_case_insensitive_map) && !InspIRCd::MatchCIDR(user->GetIPString(), *iter, ascii_case_insensitive_map))
+ // If we don't match the host then skip to the next host.
+ if (!iter->Matches(user))
continue;
- CheckIdent(user); // Nothing on failure.
- user->CheckLines(true);
+ // We have matched an <cgihost> block! Try to parse the encoded IPv4 address
+ // out of the ident.
+ irc::sockets::sockaddrs address(user->client_sa);
+ if (!ParseIdent(user, address))
+ return MOD_RES_PASSTHRU;
+
+ // Store the hostname and IP of the gateway for later use.
+ cmd.realhost.set(user, user->GetRealHost());
+ cmd.realip.set(user, user->GetIPString());
+
+ const std::string& newident = iter->GetIdent();
+ cmd.WriteLog("Connecting user %s is using an ident gateway; changing their IP from %s to %s and their ident from %s to %s.",
+ user->uuid.c_str(), user->GetIPString().c_str(), address.addr().c_str(), user->ident.c_str(), newident.c_str());
+
+ user->ChangeIdent(newident);
+ user->SetClientIP(address);
break;
}
return MOD_RES_PASSTHRU;
}
- bool CheckIdent(LocalUser* user)
+ void OnWebIRCAuth(LocalUser* user, const WebIRC::FlagMap* flags) CXX11_OVERRIDE
{
- const char* ident;
- in_addr newip;
+ // We are only interested in connection flags. If none have been
+ // given then we have nothing to do.
+ if (!flags)
+ return;
- if (user->ident.length() == 8)
- ident = user->ident.c_str();
- else if (user->ident.length() == 9 && user->ident[0] == '~')
- ident = user->ident.c_str() + 1;
- else
- return false;
+ WebIRC::FlagMap::const_iterator cport = flags->find("remote-port");
+ if (cport != flags->end())
+ {
+ // If we can't parse the port then just give up.
+ uint16_t port = ConvToNum<uint16_t>(cport->second);
+ if (port)
+ {
+ switch (user->client_sa.family())
+ {
+ case AF_INET:
+ user->client_sa.in4.sin_port = htons(port);
+ break;
+
+ case AF_INET6:
+ user->client_sa.in6.sin6_port = htons(port);
+ break;
+
+ default:
+ // If we have reached this point then we have encountered a bug.
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BUG: OnWebIRCAuth(%s): socket type %d is unknown!",
+ user->uuid.c_str(), user->client_sa.family());
+ return;
+ }
+ }
+ }
- errno = 0;
- unsigned long ipaddr = strtoul(ident, NULL, 16);
- if (errno)
- return false;
- newip.s_addr = htonl(ipaddr);
- std::string newipstr(inet_ntoa(newip));
+ WebIRC::FlagMap::const_iterator sport = flags->find("local-port");
+ if (sport != flags->end())
+ {
+ // If we can't parse the port then just give up.
+ uint16_t port = ConvToNum<uint16_t>(sport->second);
+ if (port)
+ {
+ switch (user->server_sa.family())
+ {
+ case AF_INET:
+ user->server_sa.in4.sin_port = htons(port);
+ break;
+
+ case AF_INET6:
+ user->server_sa.in6.sin6_port = htons(port);
+ break;
+
+ default:
+ // If we have reached this point then we have encountered a bug.
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BUG: OnWebIRCAuth(%s): socket type %d is unknown!",
+ user->uuid.c_str(), user->server_sa.family());
+ return;
+ }
+ }
+ }
+ }
+
+ void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
+ {
+ if (!whois.IsSelfWhois() && !whois.GetSource()->HasPrivPermission("users/auspex"))
+ return;
- user->ident = "~cgiirc";
- HandleIdent(user, newipstr);
+ // If these fields are not set then the client is not using a gateway.
+ const std::string* realhost = cmd.realhost.get(whois.GetTarget());
+ const std::string* realip = cmd.realip.get(whois.GetTarget());
+ if (!realhost || !realip)
+ return;
- return true;
+ const std::string* gateway = cmd.gateway.get(whois.GetTarget());
+ if (gateway)
+ whois.SendLine(RPL_WHOISGATEWAY, *realhost, *realip, "is connected via the " + *gateway + " WebIRC gateway");
+ else
+ whois.SendLine(RPL_WHOISGATEWAY, *realhost, *realip, "is connected via an ident gateway");
}
Version GetVersion() CXX11_OVERRIDE
{
- return Version("Change user's hosts connecting from known CGI:IRC hosts",VF_VENDOR);
+ return Version("Enables forwarding the real IP address of a user from a gateway to the IRC server", VF_VENDOR);
}
};