2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 John Brooks <john.brooks@dereferenced.net>
6 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
7 * Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
9 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
10 * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
12 * This file is part of InspIRCd. InspIRCd is free software: you can
13 * redistribute it and/or modify it under the terms of the GNU General Public
14 * License as published by the Free Software Foundation, version 2.
16 * This program is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #include "modules/dns.h"
30 enum CGItype { PASS, IDENT, PASSFIRST, IDENTFIRST, WEBIRC };
32 // We need this method up here so that it can be accessed from anywhere
33 static void ChangeIP(User* user, const std::string& newip)
35 ServerInstance->Users->RemoveCloneCounts(user);
36 user->SetClientIP(newip.c_str());
37 ServerInstance->Users->AddClone(user);
40 /** Holds a CGI site's details
49 CGIhost(const std::string &mask, CGItype t, const std::string &spassword)
50 : hostmask(mask), type(t), password(spassword)
54 typedef std::vector<CGIhost> CGIHostlist;
58 * This is used for the webirc method of CGIIRC auth, and is (really) the best way to do these things.
59 * Syntax: WEBIRC password gateway hostname ip
60 * Where password is a shared key, gateway is the name of the WebIRC gateway and version (e.g. cgiirc), hostname
61 * is the resolved host of the client issuing the command and IP is the real IP of the client.
64 * To tie in with the rest of cgiirc module, and to avoid race conditions, /webirc is only processed locally
65 * and simply sets metadata on the user, which is later decoded on full connect to give something meaningful.
67 class CommandWebirc : public Command
71 StringExtItem gateway;
72 StringExtItem realhost;
76 CommandWebirc(Module* Creator)
77 : Command(Creator, "WEBIRC", 4)
78 , gateway("cgiirc_gateway", ExtensionItem::EXT_USER, Creator)
79 , realhost("cgiirc_realhost", ExtensionItem::EXT_USER, Creator)
80 , realip("cgiirc_realip", ExtensionItem::EXT_USER, Creator)
82 works_before_reg = true;
83 this->syntax = "password gateway hostname ip";
85 CmdResult Handle(const std::vector<std::string> ¶meters, User *user)
87 if(user->registered == REG_ALL)
90 for(CGIHostlist::iterator iter = Hosts.begin(); iter != Hosts.end(); iter++)
92 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
94 if(iter->type == WEBIRC && parameters[0] == iter->password)
96 gateway.set(user, parameters[1]);
97 realhost.set(user, user->host);
98 realip.set(user, user->GetIPString());
100 // 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
101 bool host_ok = (parameters[2].length() <= ServerInstance->Config->Limits.MaxHost);
102 const std::string& newhost = (host_ok ? parameters[2] : parameters[3]);
105 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());
107 // Where the magic happens - change their IP
108 ChangeIP(user, parameters[3]);
109 // And follow this up by changing their host
110 user->host = user->dhost = newhost;
111 user->InvalidateCache();
118 ServerInstance->SNO->WriteGlobalSno('w', "Connecting user %s tried to use WEBIRC, but didn't match any configured webirc blocks.", user->GetFullRealHost().c_str());
124 /** Resolver for CGI:IRC hostnames encoded in ident/GECOS
126 class CGIResolver : public DNS::Request
129 std::string theiruid;
130 LocalIntExt& waiting;
133 CGIResolver(DNS::Manager *mgr, Module* me, bool NotifyOpers, const std::string &source, LocalUser* u,
134 const std::string &ttype, LocalIntExt& ext)
135 : DNS::Request(mgr, me, source, DNS::QUERY_PTR), typ(ttype), theiruid(u->uuid),
136 waiting(ext), notify(NotifyOpers)
140 void OnLookupComplete(const DNS::Query *r) CXX11_OVERRIDE
142 /* Check the user still exists */
143 User* them = ServerInstance->FindUUID(theiruid);
144 if ((them) && (!them->quitting))
146 LocalUser* lu = IS_LOCAL(them);
150 const DNS::ResourceRecord &ans_record = r->answers[0];
151 if (ans_record.rdata.empty() || ans_record.rdata.length() > ServerInstance->Config->Limits.MaxHost)
155 ServerInstance->SNO->WriteGlobalSno('w', "Connecting user %s detected as using CGI:IRC (%s), changing real host to %s from %s", them->nick.c_str(), them->host.c_str(), ans_record.rdata.c_str(), typ.c_str());
157 them->host = them->dhost = ans_record.rdata;
158 them->InvalidateCache();
159 lu->CheckLines(true);
163 void OnError(const DNS::Query *r) CXX11_OVERRIDE
168 User* them = ServerInstance->FindUUID(theiruid);
169 if ((them) && (!them->quitting))
171 ServerInstance->SNO->WriteToSnoMask('w', "Connecting user %s detected as using CGI:IRC (%s), but their host can't be resolved from their %s!", them->nick.c_str(), them->host.c_str(), typ.c_str());
177 User* them = ServerInstance->FindUUID(theiruid);
180 int count = waiting.get(them);
182 waiting.set(them, count - 1);
186 class ModuleCgiIRC : public Module
190 dynamic_reference<DNS::Manager> DNS;
192 static void RecheckClass(LocalUser* user)
194 user->MyClass = NULL;
199 void HandleIdentOrPass(LocalUser* user, const std::string& newip, bool was_pass)
201 cmd.realhost.set(user, user->host);
202 cmd.realip.set(user, user->GetIPString());
203 ChangeIP(user, newip);
204 user->host = user->dhost = user->GetIPString();
205 user->InvalidateCache();
208 // Don't create the resolver if the core couldn't put the user in a connect class or when dns is disabled
209 if (user->quitting || !DNS || !user->MyClass->resolvehostnames)
212 CGIResolver* r = new CGIResolver(*this->DNS, this, cmd.notify, newip, user, (was_pass ? "PASS" : "IDENT"), waiting);
215 waiting.set(user, waiting.get(user) + 1);
216 this->DNS->Process(r);
218 catch (DNS::Exception &ex)
220 int count = waiting.get(user);
222 waiting.set(user, count - 1);
225 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());
232 , waiting("cgiirc-delay", ExtensionItem::EXT_USER, this)
237 void init() CXX11_OVERRIDE
239 ServerInstance->SNO->EnableSnomask('w', "CGIIRC");
242 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
246 // Do we send an oper notice when a CGI:IRC has their host changed?
247 cmd.notify = ServerInstance->Config->ConfValue("cgiirc")->getBool("opernotice", true);
249 ConfigTagList tags = ServerInstance->Config->ConfTags("cgihost");
250 for (ConfigIter i = tags.first; i != tags.second; ++i)
252 ConfigTag* tag = i->second;
253 std::string hostmask = tag->getString("mask"); // An allowed CGI:IRC host
254 std::string type = tag->getString("type"); // What type of user-munging we do on this host.
255 std::string password = tag->getString("password");
257 if(hostmask.length())
259 if (type == "webirc" && password.empty())
261 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Missing password in config: %s", hostmask.c_str());
268 else if (type == "ident")
270 else if (type == "passfirst")
272 else if (type == "webirc")
277 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Invalid <cgihost:type> value in config: %s, setting it to \"pass\"", type.c_str());
280 cmd.Hosts.push_back(CGIhost(hostmask, cgitype, password));
285 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Invalid <cgihost:mask> value in config: %s", hostmask.c_str());
291 ModResult OnCheckReady(LocalUser *user) CXX11_OVERRIDE
293 if (waiting.get(user))
296 if (!cmd.realip.get(user))
297 return MOD_RES_PASSTHRU;
303 user->CheckLines(true);
307 return MOD_RES_PASSTHRU;
310 ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
312 // If <connect:webirc> is not set then we have nothing to do.
313 const std::string webirc = myclass->config->getString("webirc");
315 return MOD_RES_PASSTHRU;
317 // If the user is not connecting via a WebIRC gateway then they
318 // cannot match this connect class.
319 const std::string* gateway = cmd.gateway.get(user);
323 // If the gateway matches the <connect:webirc> constraint then
324 // allow the check to continue. Otherwise, reject it.
325 return InspIRCd::Match(*gateway, webirc) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
328 ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
330 for(CGIHostlist::iterator iter = cmd.Hosts.begin(); iter != cmd.Hosts.end(); iter++)
332 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
335 if(iter->type == PASS)
337 CheckPass(user); // We do nothing if it fails so...
338 user->CheckLines(true);
340 else if(iter->type == PASSFIRST && !CheckPass(user))
342 // If the password lookup failed, try the ident
343 CheckIdent(user); // If this fails too, do nothing
344 user->CheckLines(true);
346 else if(iter->type == IDENT)
348 CheckIdent(user); // Nothing on failure.
349 user->CheckLines(true);
351 else if(iter->type == IDENTFIRST && !CheckIdent(user))
353 // If the ident lookup fails, try the password.
355 user->CheckLines(true);
357 else if(iter->type == WEBIRC)
359 // We don't need to do anything here
361 return MOD_RES_PASSTHRU;
364 return MOD_RES_PASSTHRU;
367 bool CheckPass(LocalUser* user)
369 if(IsValidHost(user->password))
371 HandleIdentOrPass(user, user->password, true);
372 user->password.clear();
379 bool CheckIdent(LocalUser* user)
384 if (user->ident.length() == 8)
385 ident = user->ident.c_str();
386 else if (user->ident.length() == 9 && user->ident[0] == '~')
387 ident = user->ident.c_str() + 1;
392 unsigned long ipaddr = strtoul(ident, NULL, 16);
395 newip.s_addr = htonl(ipaddr);
396 std::string newipstr(inet_ntoa(newip));
398 user->ident = "~cgiirc";
399 HandleIdentOrPass(user, newipstr, false);
404 bool IsValidHost(const std::string &host)
406 if(!host.size() || host.size() > ServerInstance->Config->Limits.MaxHost)
409 for(unsigned int i = 0; i < host.size(); i++)
411 if( ((host[i] >= '0') && (host[i] <= '9')) ||
412 ((host[i] >= 'A') && (host[i] <= 'Z')) ||
413 ((host[i] >= 'a') && (host[i] <= 'z')) ||
414 ((host[i] == '-') && (i > 0) && (i+1 < host.size()) && (host[i-1] != '.') && (host[i+1] != '.')) ||
415 ((host[i] == '.') && (i > 0) && (i+1 < host.size())) )
425 Version GetVersion() CXX11_OVERRIDE
427 return Version("Change user's hosts connecting from known CGI:IRC hosts",VF_VENDOR);
431 MODULE_INIT(ModuleCgiIRC)