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 client hostname ip
60 * Where password is a shared key, client is the name of the "client" 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 realhost;
75 CommandWebirc(Module* Creator)
76 : Command(Creator, "WEBIRC", 4),
77 realhost("cgiirc_realhost", ExtensionItem::EXT_USER, Creator)
78 , realip("cgiirc_realip", ExtensionItem::EXT_USER, Creator)
80 allow_empty_last_param = false;
81 works_before_reg = true;
82 this->syntax = "password client hostname ip";
84 CmdResult Handle(const std::vector<std::string> ¶meters, User *user)
86 if(user->registered == REG_ALL)
89 irc::sockets::sockaddrs ipaddr;
90 if (!irc::sockets::aptosa(parameters[3], 0, ipaddr))
92 IS_LOCAL(user)->CommandFloodPenalty += 5000;
93 ServerInstance->SNO->WriteGlobalSno('a', "Connecting user %s tried to use WEBIRC but gave an invalid IP address.", user->GetFullRealHost().c_str());
97 for(CGIHostlist::iterator iter = Hosts.begin(); iter != Hosts.end(); iter++)
99 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
101 if(iter->type == WEBIRC && parameters[0] == iter->password)
103 realhost.set(user, user->host);
104 realip.set(user, user->GetIPString());
106 // 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
107 bool host_ok = (parameters[2].length() <= ServerInstance->Config->Limits.MaxHost);
108 const std::string& newhost = (host_ok ? parameters[2] : parameters[3]);
111 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());
113 // Where the magic happens - change their IP
114 ChangeIP(user, parameters[3]);
115 // And follow this up by changing their host
116 user->host = user->dhost = newhost;
117 user->InvalidateCache();
124 IS_LOCAL(user)->CommandFloodPenalty += 5000;
125 ServerInstance->SNO->WriteGlobalSno('w', "Connecting user %s tried to use WEBIRC, but didn't match any configured webirc blocks.", user->GetFullRealHost().c_str());
131 /** Resolver for CGI:IRC hostnames encoded in ident/GECOS
133 class CGIResolver : public DNS::Request
136 std::string theiruid;
137 LocalIntExt& waiting;
140 CGIResolver(DNS::Manager *mgr, Module* me, bool NotifyOpers, const std::string &source, LocalUser* u,
141 const std::string &ttype, LocalIntExt& ext)
142 : DNS::Request(mgr, me, source, DNS::QUERY_PTR), typ(ttype), theiruid(u->uuid),
143 waiting(ext), notify(NotifyOpers)
147 void OnLookupComplete(const DNS::Query *r) CXX11_OVERRIDE
149 /* Check the user still exists */
150 User* them = ServerInstance->FindUUID(theiruid);
151 if ((them) && (!them->quitting))
153 LocalUser* lu = IS_LOCAL(them);
157 const DNS::ResourceRecord &ans_record = r->answers[0];
158 if (ans_record.rdata.empty() || ans_record.rdata.length() > ServerInstance->Config->Limits.MaxHost)
162 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());
164 them->host = them->dhost = ans_record.rdata;
165 them->InvalidateCache();
166 lu->CheckLines(true);
170 void OnError(const DNS::Query *r) CXX11_OVERRIDE
175 User* them = ServerInstance->FindUUID(theiruid);
176 if ((them) && (!them->quitting))
178 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());
184 User* them = ServerInstance->FindUUID(theiruid);
187 int count = waiting.get(them);
189 waiting.set(them, count - 1);
193 class ModuleCgiIRC : public Module
197 dynamic_reference<DNS::Manager> DNS;
199 static void RecheckClass(LocalUser* user)
201 user->MyClass = NULL;
206 void HandleIdentOrPass(LocalUser* user, const std::string& newip, bool was_pass)
208 cmd.realhost.set(user, user->host);
209 cmd.realip.set(user, user->GetIPString());
210 ChangeIP(user, newip);
211 user->host = user->dhost = user->GetIPString();
212 user->InvalidateCache();
215 // Don't create the resolver if the core couldn't put the user in a connect class or when dns is disabled
216 if (user->quitting || !DNS || !user->MyClass->resolvehostnames)
219 CGIResolver* r = new CGIResolver(*this->DNS, this, cmd.notify, newip, user, (was_pass ? "PASS" : "IDENT"), waiting);
222 waiting.set(user, waiting.get(user) + 1);
223 this->DNS->Process(r);
225 catch (DNS::Exception &ex)
227 int count = waiting.get(user);
229 waiting.set(user, count - 1);
232 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());
239 , waiting("cgiirc-delay", ExtensionItem::EXT_USER, this)
244 void init() CXX11_OVERRIDE
246 ServerInstance->SNO->EnableSnomask('w', "CGIIRC");
249 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
253 // Do we send an oper notice when a CGI:IRC has their host changed?
254 cmd.notify = ServerInstance->Config->ConfValue("cgiirc")->getBool("opernotice", true);
256 ConfigTagList tags = ServerInstance->Config->ConfTags("cgihost");
257 for (ConfigIter i = tags.first; i != tags.second; ++i)
259 ConfigTag* tag = i->second;
260 std::string hostmask = tag->getString("mask"); // An allowed CGI:IRC host
261 std::string type = tag->getString("type"); // What type of user-munging we do on this host.
262 std::string password = tag->getString("password");
264 if(hostmask.length())
266 if (type == "webirc" && password.empty())
268 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Missing password in config: %s", hostmask.c_str());
275 else if (type == "ident")
277 else if (type == "passfirst")
279 else if (type == "webirc")
284 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Invalid <cgihost:type> value in config: %s, setting it to \"pass\"", type.c_str());
287 cmd.Hosts.push_back(CGIhost(hostmask, cgitype, password));
292 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Invalid <cgihost:mask> value in config: %s", hostmask.c_str());
298 ModResult OnCheckReady(LocalUser *user) CXX11_OVERRIDE
300 if (waiting.get(user))
303 if (!cmd.realip.get(user))
304 return MOD_RES_PASSTHRU;
310 user->CheckLines(true);
314 return MOD_RES_PASSTHRU;
317 ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
319 for(CGIHostlist::iterator iter = cmd.Hosts.begin(); iter != cmd.Hosts.end(); iter++)
321 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
324 if(iter->type == PASS)
326 CheckPass(user); // We do nothing if it fails so...
327 user->CheckLines(true);
329 else if(iter->type == PASSFIRST && !CheckPass(user))
331 // If the password lookup failed, try the ident
332 CheckIdent(user); // If this fails too, do nothing
333 user->CheckLines(true);
335 else if(iter->type == IDENT)
337 CheckIdent(user); // Nothing on failure.
338 user->CheckLines(true);
340 else if(iter->type == IDENTFIRST && !CheckIdent(user))
342 // If the ident lookup fails, try the password.
344 user->CheckLines(true);
346 else if(iter->type == WEBIRC)
348 // We don't need to do anything here
350 return MOD_RES_PASSTHRU;
353 return MOD_RES_PASSTHRU;
356 bool CheckPass(LocalUser* user)
358 if(IsValidHost(user->password))
360 HandleIdentOrPass(user, user->password, true);
361 user->password.clear();
368 bool CheckIdent(LocalUser* user)
373 if (user->ident.length() == 8)
374 ident = user->ident.c_str();
375 else if (user->ident.length() == 9 && user->ident[0] == '~')
376 ident = user->ident.c_str() + 1;
381 unsigned long ipaddr = strtoul(ident, NULL, 16);
384 newip.s_addr = htonl(ipaddr);
385 std::string newipstr(inet_ntoa(newip));
387 user->ident = "~cgiirc";
388 HandleIdentOrPass(user, newipstr, false);
393 bool IsValidHost(const std::string &host)
395 if(!host.size() || host.size() > ServerInstance->Config->Limits.MaxHost)
398 for(unsigned int i = 0; i < host.size(); i++)
400 if( ((host[i] >= '0') && (host[i] <= '9')) ||
401 ((host[i] >= 'A') && (host[i] <= 'Z')) ||
402 ((host[i] >= 'a') && (host[i] <= 'z')) ||
403 ((host[i] == '-') && (i > 0) && (i+1 < host.size()) && (host[i-1] != '.') && (host[i+1] != '.')) ||
404 ((host[i] == '.') && (i > 0) && (i+1 < host.size())) )
414 Version GetVersion() CXX11_OVERRIDE
416 return Version("Change user's hosts connecting from known CGI:IRC hosts",VF_VENDOR);
420 MODULE_INIT(ModuleCgiIRC)