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 };
33 /** Holds a CGI site's details
42 CGIhost(const std::string &mask, CGItype t, const std::string &spassword)
43 : hostmask(mask), type(t), password(spassword)
47 typedef std::vector<CGIhost> CGIHostlist;
51 * This is used for the webirc method of CGIIRC auth, and is (really) the best way to do these things.
52 * Syntax: WEBIRC password client hostname ip
53 * Where password is a shared key, client is the name of the "client" and version (e.g. cgiirc), hostname
54 * is the resolved host of the client issuing the command and IP is the real IP of the client.
57 * To tie in with the rest of cgiirc module, and to avoid race conditions, /webirc is only processed locally
58 * and simply sets metadata on the user, which is later decoded on full connect to give something meaningful.
60 class CommandWebirc : public Command
64 StringExtItem realhost;
66 LocalStringExt webirc_hostname;
67 LocalStringExt webirc_ip;
70 CommandWebirc(Module* Creator)
71 : Command(Creator, "WEBIRC", 4),
72 realhost("cgiirc_realhost", Creator), realip("cgiirc_realip", Creator),
73 webirc_hostname("cgiirc_webirc_hostname", Creator), webirc_ip("cgiirc_webirc_ip", Creator)
75 works_before_reg = true;
76 this->syntax = "password client hostname ip";
78 CmdResult Handle(const std::vector<std::string> ¶meters, User *user)
80 if(user->registered == REG_ALL)
83 for(CGIHostlist::iterator iter = Hosts.begin(); iter != Hosts.end(); iter++)
85 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
87 if(iter->type == WEBIRC && parameters[0] == iter->password)
89 realhost.set(user, user->host);
90 realip.set(user, user->GetIPString());
92 bool host_ok = (parameters[2].length() < 64);
93 const std::string& newhost = (host_ok ? parameters[2] : parameters[3]);
96 ServerInstance->SNO->WriteGlobalSno('a', "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());
98 // 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
100 webirc_hostname.set(user, parameters[2]);
102 webirc_hostname.unset(user);
104 webirc_ip.set(user, parameters[3]);
110 ServerInstance->SNO->WriteGlobalSno('a', "Connecting user %s tried to use WEBIRC, but didn't match any configured webirc blocks.", user->GetFullRealHost().c_str());
116 /** Resolver for CGI:IRC hostnames encoded in ident/GECOS
118 class CGIResolver : public DNS::Request
121 std::string theiruid;
122 LocalIntExt& waiting;
125 CGIResolver(DNS::Manager *mgr, Module* me, bool NotifyOpers, const std::string &source, LocalUser* u,
126 const std::string &ttype, LocalIntExt& ext)
127 : DNS::Request(mgr, me, source, DNS::QUERY_PTR), typ(ttype), theiruid(u->uuid),
128 waiting(ext), notify(NotifyOpers)
132 void OnLookupComplete(const DNS::Query *r) CXX11_OVERRIDE
134 /* Check the user still exists */
135 User* them = ServerInstance->FindUUID(theiruid);
136 if ((them) && (!them->quitting))
138 LocalUser* lu = IS_LOCAL(them);
142 const DNS::ResourceRecord &ans_record = r->answers[0];
143 if (ans_record.rdata.empty() || ans_record.rdata.length() > 64)
147 ServerInstance->SNO->WriteGlobalSno('a', "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());
149 them->host = them->dhost = ans_record.rdata;
150 them->InvalidateCache();
151 lu->CheckLines(true);
155 void OnError(const DNS::Query *r) CXX11_OVERRIDE
160 User* them = ServerInstance->FindUUID(theiruid);
161 if ((them) && (!them->quitting))
163 ServerInstance->SNO->WriteToSnoMask('a', "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());
169 User* them = ServerInstance->FindUUID(theiruid);
172 int count = waiting.get(them);
174 waiting.set(them, count - 1);
178 class ModuleCgiIRC : public Module
182 dynamic_reference<DNS::Manager> DNS;
184 static void RecheckClass(LocalUser* user)
186 user->MyClass = NULL;
191 static void ChangeIP(LocalUser* user, const std::string& newip)
193 ServerInstance->Users->RemoveCloneCounts(user);
194 user->SetClientIP(newip.c_str());
195 ServerInstance->Users->AddLocalClone(user);
196 ServerInstance->Users->AddGlobalClone(user);
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('a', "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());
232 , waiting("cgiirc-delay", this)
237 void init() CXX11_OVERRIDE
240 ServiceProvider* providerlist[] = { &cmd, &cmd.realhost, &cmd.realip, &cmd.webirc_hostname, &cmd.webirc_ip, &waiting };
241 ServerInstance->Modules->AddServices(providerlist, sizeof(providerlist)/sizeof(ServiceProvider*));
244 void OnRehash(User* user) CXX11_OVERRIDE
248 // Do we send an oper notice when a CGI:IRC has their host changed?
249 cmd.notify = ServerInstance->Config->ConfValue("cgiirc")->getBool("opernotice", true);
251 ConfigTagList tags = ServerInstance->Config->ConfTags("cgihost");
252 for (ConfigIter i = tags.first; i != tags.second; ++i)
254 ConfigTag* tag = i->second;
255 std::string hostmask = tag->getString("mask"); // An allowed CGI:IRC host
256 std::string type = tag->getString("type"); // What type of user-munging we do on this host.
257 std::string password = tag->getString("password");
259 if(hostmask.length())
261 if (type == "webirc" && password.empty())
263 ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, "m_cgiirc: Missing password in config: %s", hostmask.c_str());
270 else if (type == "ident")
272 else if (type == "passfirst")
274 else if (type == "webirc")
279 ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, "Invalid <cgihost:type> value in config: %s, setting it to \"pass\"", type.c_str());
282 cmd.Hosts.push_back(CGIhost(hostmask, cgitype, password));
287 ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, "Invalid <cgihost:mask> value in config: %s", hostmask.c_str());
293 ModResult OnCheckReady(LocalUser *user) CXX11_OVERRIDE
295 if (waiting.get(user))
298 std::string *webirc_ip = cmd.webirc_ip.get(user);
300 return MOD_RES_PASSTHRU;
302 ChangeIP(user, *webirc_ip);
304 std::string* webirc_hostname = cmd.webirc_hostname.get(user);
305 user->host = user->dhost = (webirc_hostname ? *webirc_hostname : user->GetIPString());
311 user->CheckLines(true);
315 cmd.webirc_hostname.unset(user);
316 cmd.webirc_ip.unset(user);
318 return MOD_RES_PASSTHRU;
321 ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
323 for(CGIHostlist::iterator iter = cmd.Hosts.begin(); iter != cmd.Hosts.end(); iter++)
325 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
328 if(iter->type == PASS)
330 CheckPass(user); // We do nothing if it fails so...
331 user->CheckLines(true);
333 else if(iter->type == PASSFIRST && !CheckPass(user))
335 // If the password lookup failed, try the ident
336 CheckIdent(user); // If this fails too, do nothing
337 user->CheckLines(true);
339 else if(iter->type == IDENT)
341 CheckIdent(user); // Nothing on failure.
342 user->CheckLines(true);
344 else if(iter->type == IDENTFIRST && !CheckIdent(user))
346 // If the ident lookup fails, try the password.
348 user->CheckLines(true);
350 else if(iter->type == WEBIRC)
352 // We don't need to do anything here
354 return MOD_RES_PASSTHRU;
357 return MOD_RES_PASSTHRU;
360 bool CheckPass(LocalUser* user)
362 if(IsValidHost(user->password))
364 HandleIdentOrPass(user, user->password, true);
365 user->password.clear();
372 bool CheckIdent(LocalUser* user)
377 if (user->ident.length() == 8)
378 ident = user->ident.c_str();
379 else if (user->ident.length() == 9 && user->ident[0] == '~')
380 ident = user->ident.c_str() + 1;
385 unsigned long ipaddr = strtoul(ident, NULL, 16);
388 newip.s_addr = htonl(ipaddr);
389 std::string newipstr(inet_ntoa(newip));
391 user->ident = "~cgiirc";
392 HandleIdentOrPass(user, newipstr, false);
397 bool IsValidHost(const std::string &host)
399 if(!host.size() || host.size() > 64)
402 for(unsigned int i = 0; i < host.size(); i++)
404 if( ((host[i] >= '0') && (host[i] <= '9')) ||
405 ((host[i] >= 'A') && (host[i] <= 'Z')) ||
406 ((host[i] >= 'a') && (host[i] <= 'z')) ||
407 ((host[i] == '-') && (i > 0) && (i+1 < host.size()) && (host[i-1] != '.') && (host[i+1] != '.')) ||
408 ((host[i] == '.') && (i > 0) && (i+1 < host.size())) )
418 Version GetVersion() CXX11_OVERRIDE
420 return Version("Change user's hosts connecting from known CGI:IRC hosts",VF_VENDOR);
425 MODULE_INIT(ModuleCgiIRC)