#include "inspircd.h"
-#include "xline.h"
-#include "modules/dns.h"
+#include "modules/ssl.h"
+#include "modules/whois.h"
-enum CGItype { IDENT, WEBIRC };
+enum
+{
+ // InspIRCd-specific.
+ RPL_WHOISGATEWAY = 350
+};
// We need this method up here so that it can be accessed from anywhere
static void ChangeIP(User* user, const std::string& newip)
{
ServerInstance->Users->RemoveCloneCounts(user);
- user->SetClientIP(newip.c_str());
+ user->SetClientIP(newip);
ServerInstance->Users->AddClone(user);
}
-/** Holds a CGI site's details
- */
-class CGIhost
+// Encapsulates information about a WebIRC host.
+class WebIRCHost
{
-public:
+ private:
std::string hostmask;
- CGItype type;
+ std::string fingerprint;
std::string password;
+ std::string passhash;
+
+ public:
+ 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)
+ {
+ }
- CGIhost(const std::string &mask, CGItype t, const std::string &spassword)
- : hostmask(mask), type(t), password(spassword)
+ bool Matches(LocalUser* user, const std::string& pass) const
{
+ // Did the user send a valid password?
+ if (!password.empty() && !ServerInstance->PassCompare(user, password, pass, passhash))
+ return false;
+
+ // Does the user have a valid fingerprint?
+ const std::string fp = SSLClientCert::GetFingerprint(&user->eh);
+ if (!fingerprint.empty() && fp != fingerprint)
+ return false;
+
+ // Does the user's hostname match our hostmask?
+ if (InspIRCd::Match(user->GetRealHost(), hostmask, ascii_case_insensitive_map))
+ return true;
+
+ // Does the user's IP address match our hostmask?
+ return InspIRCd::MatchCIDR(user->GetIPString(), hostmask, ascii_case_insensitive_map);
}
};
-typedef std::vector<CGIhost> CGIHostlist;
/*
* WEBIRC
class CommandWebIRC : public SplitCommand
{
public:
+ std::vector<WebIRCHost> hosts;
bool notify;
StringExtItem gateway;
StringExtItem realhost;
StringExtItem realip;
- CGIHostlist Hosts;
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)
- {
- 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;
-
- irc::sockets::sockaddrs ipaddr;
- if (!irc::sockets::aptosa(parameters[3], 0, 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());
- return CMD_FAILURE;
- }
+ {
+ allow_empty_last_param = false;
+ works_before_reg = true;
+ this->syntax = "password gateway hostname ip";
+ }
- for(CGIHostlist::iterator iter = Hosts.begin(); iter != Hosts.end(); iter++)
- {
- if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
- {
- if(iter->type == WEBIRC && parameters[0] == iter->password)
- {
- 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);
- 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;
- }
- }
- }
+ CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
+ {
+ if (user->registered == REG_ALL)
+ return CMD_FAILURE;
+ irc::sockets::sockaddrs ipaddr;
+ if (!irc::sockets::aptosa(parameters[3], 0, ipaddr))
+ {
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());
+ WriteLog("Connecting user %s (%s) tried to use WEBIRC but gave an invalid IP address.",
+ user->uuid.c_str(), user->GetIPString().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)
- {
- }
- void OnLookupComplete(const DNS::Query *r) CXX11_OVERRIDE
- {
- /* Check the user still exists */
- User* them = ServerInstance->FindUUID(theiruid);
- if ((them) && (!them->quitting))
+ for (std::vector<WebIRCHost>::const_iterator iter = hosts.begin(); iter != hosts.end(); ++iter)
{
- LocalUser* lu = IS_LOCAL(them);
- if (!lu)
- return;
+ // If we don't match the host then skip to the next host.
+ if (!iter->Matches(user, parameters[0]))
+ continue;
- const DNS::ResourceRecord &ans_record = r->answers[0];
- if (ans_record.rdata.empty() || ans_record.rdata.length() > ServerInstance->Config->Limits.MaxHost)
- return;
+ // The user matched a WebIRC block!
+ gateway.set(user, parameters[1]);
+ realhost.set(user, user->GetRealHost());
+ realip.set(user, user->GetIPString());
- 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());
+ 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());
- 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.
+ ChangeIP(user, parameters[3]);
+ 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());
- }
+ user->CommandFloodPenalty += 5000;
+ 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());
+ 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 Whois::EventListener
{
CommandWebIRC cmd;
- LocalIntExt waiting;
- dynamic_reference<DNS::Manager> DNS;
+ std::vector<std::string> hosts;
static void RecheckClass(LocalUser* user)
{
void HandleIdent(LocalUser* user, const std::string& newip)
{
- cmd.realhost.set(user, user->host);
+ cmd.realhost.set(user, user->GetRealHost());
cmd.realip.set(user, user->GetIPString());
+
+ cmd.WriteLog("Connecting user %s is using an ident gateway; changing their IP from %s to %s.",
+ user->uuid.c_str(), user->GetIPString().c_str(), newip.c_str());
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
- {
- waiting.set(user, waiting.get(user) + 1);
- this->DNS->Process(r);
- }
- catch (DNS::Exception &ex)
- {
- 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());
- }
}
public:
ModuleCgiIRC()
- : cmd(this)
- , waiting("cgiirc-delay", ExtensionItem::EXT_USER, this)
- , DNS(this, "DNS")
+ : Whois::EventListener(this)
+ , cmd(this)
{
}
void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- cmd.Hosts.clear();
-
- // Do we send an oper notice when a CGI:IRC has their host changed?
- cmd.notify = ServerInstance->Config->ConfValue("cgiirc")->getBool("opernotice", true);
+ std::vector<std::string> identhosts;
+ std::vector<WebIRCHost> webirchosts;
ConfigTagList tags = ServerInstance->Config->ConfTags("cgihost");
for (ConfigIter i = tags.first; i != tags.second; ++i)
{
ConfigTag* tag = i->second;
- std::string hostmask = tag->getString("mask"); // An allowed CGI:IRC host
- std::string type = tag->getString("type"); // What type of user-munging we do on this host.
- std::string password = tag->getString("password");
- if(hostmask.length())
+ // Ensure that we have the <cgihost:mask> parameter.
+ const std::string mask = tag->getString("mask");
+ if (mask.empty())
+ throw ModuleException("<cgihost:mask> is a mandatory field, at " + tag->getTagLocation());
+
+ // Determine what lookup type this host uses.
+ const std::string type = tag->getString("type");
+ if (stdalgo::string::equalsci(type, "ident"))
{
- if (type == "webirc" && password.empty())
- {
- ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Missing password in config: %s", hostmask.c_str());
- }
- else
- {
- CGItype cgitype;
- if (type == "ident")
- cgitype = IDENT;
- else if (type == "webirc")
- cgitype = WEBIRC;
- else
- {
- cgitype = IDENT;
- ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Invalid <cgihost:type> value in config: %s, setting it to \"ident\"", type.c_str());
- }
-
- cmd.Hosts.push_back(CGIhost(hostmask, cgitype, password));
- }
+ // The IP address should be looked up from the hex IP address.
+ identhosts.push_back(mask);
+ }
+ 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 (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, fingerprint, password, tag->getString("hash")));
}
else
{
- ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Invalid <cgihost:mask> value in config: %s", hostmask.c_str());
- continue;
+ throw ModuleException(type + " is an invalid <cgihost:mask> type, at " + tag->getTagLocation());
}
}
+
+ // The host configuration was valid so we can apply it.
+ hosts.swap(identhosts);
+ cmd.hosts.swap(webirchosts);
+
+ // 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;
ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
{
- for(CGIHostlist::iterator iter = cmd.Hosts.begin(); iter != cmd.Hosts.end(); iter++)
+ for (std::vector<std::string>::const_iterator iter = hosts.begin(); iter != hosts.end(); ++iter)
{
- if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
- {
- // Deal with it...
- if(iter->type == IDENT)
- {
- CheckIdent(user); // Nothing on failure.
- user->CheckLines(true);
- }
- else if(iter->type == WEBIRC)
- {
- // We don't need to do anything here
- }
- return MOD_RES_PASSTHRU;
- }
+ if (!InspIRCd::Match(user->GetRealHost(), *iter, ascii_case_insensitive_map) && !InspIRCd::MatchCIDR(user->GetIPString(), *iter, ascii_case_insensitive_map))
+ continue;
+
+ CheckIdent(user); // Nothing on failure.
+ user->CheckLines(true);
+ break;
}
return MOD_RES_PASSTHRU;
}
+ void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
+ {
+ if (!whois.IsSelfWhois() && !whois.GetSource()->HasPrivPermission("users/auspex"))
+ return;
+
+ // 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;
+
+ 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");
+ }
+
bool CheckIdent(LocalUser* user)
{
const char* ident;
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);
}
};