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/>.
29 /* $ModDesc: Change user's hosts connecting from known CGI:IRC hosts */
31 enum CGItype { PASS, IDENT, PASSFIRST, IDENTFIRST, WEBIRC };
34 /** Holds a CGI site's details
43 CGIhost(const std::string &mask, CGItype t, const std::string &spassword)
44 : hostmask(mask), type(t), password(spassword)
48 typedef std::vector<CGIhost> CGIHostlist;
52 * This is used for the webirc method of CGIIRC auth, and is (really) the best way to do these things.
53 * Syntax: WEBIRC password client hostname ip
54 * Where password is a shared key, client is the name of the "client" and version (e.g. cgiirc), hostname
55 * is the resolved host of the client issuing the command and IP is the real IP of the client.
58 * To tie in with the rest of cgiirc module, and to avoid race conditions, /webirc is only processed locally
59 * and simply sets metadata on the user, which is later decoded on full connect to give something meaningful.
61 class CommandWebirc : public Command
65 StringExtItem realhost;
67 LocalStringExt webirc_hostname;
68 LocalStringExt webirc_ip;
71 CommandWebirc(Module* Creator)
72 : Command(Creator, "WEBIRC", 4),
73 realhost("cgiirc_realhost", Creator), realip("cgiirc_realip", Creator),
74 webirc_hostname("cgiirc_webirc_hostname", Creator), webirc_ip("cgiirc_webirc_ip", Creator)
76 allow_empty_last_param = false;
77 works_before_reg = true;
78 this->syntax = "password client hostname ip";
80 CmdResult Handle(const std::vector<std::string> ¶meters, User *user)
82 if(user->registered == REG_ALL)
85 irc::sockets::sockaddrs ipaddr;
86 if (!irc::sockets::aptosa(parameters[3], 0, ipaddr))
88 IS_LOCAL(user)->CommandFloodPenalty += 5000;
89 ServerInstance->SNO->WriteGlobalSno('a', "Connecting user %s tried to use WEBIRC but gave an invalid IP address.", user->GetFullRealHost().c_str());
93 for(CGIHostlist::iterator iter = Hosts.begin(); iter != Hosts.end(); iter++)
95 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
97 if(iter->type == WEBIRC && parameters[0] == iter->password)
99 realhost.set(user, user->host);
100 realip.set(user, user->GetIPString());
102 // Check if we're happy with the provided hostname. If it's problematic then use the IP instead.
103 bool host_ok = (parameters[2].length() < 64) && (parameters[2].find_first_not_of("0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.:-") == std::string::npos);
104 const std::string& newhost = (host_ok ? parameters[2] : parameters[3]);
107 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());
109 webirc_hostname.set(user, newhost);
110 webirc_ip.set(user, parameters[3]);
116 IS_LOCAL(user)->CommandFloodPenalty += 5000;
117 ServerInstance->SNO->WriteGlobalSno('a', "Connecting user %s tried to use WEBIRC, but didn't match any configured webirc blocks.", user->GetFullRealHost().c_str());
123 /** Resolver for CGI:IRC hostnames encoded in ident/GECOS
125 class CGIResolver : public Resolver
128 std::string theiruid;
129 LocalIntExt& waiting;
132 CGIResolver(Module* me, bool NotifyOpers, const std::string &source, LocalUser* u,
133 const std::string &type, bool &cached, LocalIntExt& ext)
134 : Resolver(source, DNS_QUERY_PTR4, cached, me), typ(type), theiruid(u->uuid),
135 waiting(ext), notify(NotifyOpers)
139 virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached)
141 /* Check the user still exists */
142 User* them = ServerInstance->FindUUID(theiruid);
143 if ((them) && (!them->quitting))
146 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(), result.c_str(), typ.c_str());
148 if (result.length() > 64)
151 them->dhost = result;
152 them->InvalidateCache();
153 them->CheckLines(true);
157 virtual void OnError(ResolverError e, const std::string &errormessage)
162 User* them = ServerInstance->FindUUID(theiruid);
163 if ((them) && (!them->quitting))
165 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 virtual ~CGIResolver()
171 User* them = ServerInstance->FindUUID(theiruid);
174 int count = waiting.get(them);
176 waiting.set(them, count - 1);
180 class ModuleCgiIRC : public Module
185 static void RecheckClass(LocalUser* user)
187 user->MyClass = NULL;
192 static void ChangeIP(LocalUser* user, const std::string& newip)
194 ServerInstance->Users->RemoveCloneCounts(user);
195 const std::string oldip(user->GetIPString());
196 user->SetClientIP(newip.c_str());
197 user->InvalidateCache();
198 if (user->host == oldip)
199 user->host = user->GetIPString();
200 if (user->dhost == oldip)
201 user->dhost = user->GetIPString();
202 ServerInstance->Users->AddLocalClone(user);
203 ServerInstance->Users->AddGlobalClone(user);
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 user->host = user->dhost = user->GetIPString();
211 ChangeIP(user, newip);
212 user->InvalidateCache();
214 // Don't create the resolver if the core couldn't put the user in a connect class or when dns is disabled
215 if (user->quitting || ServerInstance->Config->NoUserDns)
221 CGIResolver* r = new CGIResolver(this, cmd.notify, newip, user, (was_pass ? "PASS" : "IDENT"), cached, waiting);
222 waiting.set(user, waiting.get(user) + 1);
223 ServerInstance->AddResolver(r, cached);
228 ServerInstance->SNO->WriteToSnoMask('a', "Connecting user %s detected as using CGI:IRC (%s), but I could not resolve their hostname!", user->nick.c_str(), user->host.c_str());
233 ModuleCgiIRC() : cmd(this), waiting("cgiirc-delay", this)
240 ServiceProvider* providerlist[] = { &cmd, &cmd.realhost, &cmd.realip, &cmd.webirc_hostname, &cmd.webirc_ip, &waiting };
241 ServerInstance->Modules->AddServices(providerlist, sizeof(providerlist)/sizeof(ServiceProvider*));
243 Implementation eventlist[] = { I_OnRehash, I_OnUserRegister, I_OnCheckReady };
244 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
247 void OnRehash(User* user)
251 // Do we send an oper notice when a CGI:IRC has their host changed?
252 cmd.notify = ServerInstance->Config->ConfValue("cgiirc")->getBool("opernotice", true);
254 ConfigTagList tags = ServerInstance->Config->ConfTags("cgihost");
255 for (ConfigIter i = tags.first; i != tags.second; ++i)
257 ConfigTag* tag = i->second;
258 std::string hostmask = tag->getString("mask"); // An allowed CGI:IRC host
259 std::string type = tag->getString("type"); // What type of user-munging we do on this host.
260 std::string password = tag->getString("password");
262 if(hostmask.length())
264 if (type == "webirc" && password.empty())
266 ServerInstance->Logs->Log("CONFIG",DEFAULT, "m_cgiirc: Missing password in config: %s", hostmask.c_str());
273 else if (type == "ident")
275 else if (type == "passfirst")
277 else if (type == "webirc")
282 ServerInstance->Logs->Log("CONFIG",DEFAULT, "m_cgiirc.so: Invalid <cgihost:type> value in config: %s, setting it to \"pass\"", type.c_str());
285 cmd.Hosts.push_back(CGIhost(hostmask, cgitype, password));
290 ServerInstance->Logs->Log("CONFIG",DEFAULT, "m_cgiirc.so: Invalid <cgihost:mask> value in config: %s", hostmask.c_str());
296 ModResult OnCheckReady(LocalUser *user)
298 if (waiting.get(user))
301 std::string *webirc_ip = cmd.webirc_ip.get(user);
303 return MOD_RES_PASSTHRU;
305 std::string* webirc_hostname = cmd.webirc_hostname.get(user);
306 user->host = user->dhost = (webirc_hostname ? *webirc_hostname : user->GetIPString());
308 ChangeIP(user, *webirc_ip);
309 user->InvalidateCache();
315 user->CheckLines(true);
319 cmd.webirc_hostname.unset(user);
320 cmd.webirc_ip.unset(user);
322 return MOD_RES_PASSTHRU;
325 ModResult OnUserRegister(LocalUser* user)
327 for(CGIHostlist::iterator iter = cmd.Hosts.begin(); iter != cmd.Hosts.end(); iter++)
329 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
332 if(iter->type == PASS)
334 CheckPass(user); // We do nothing if it fails so...
335 user->CheckLines(true);
337 else if(iter->type == PASSFIRST && !CheckPass(user))
339 // If the password lookup failed, try the ident
340 CheckIdent(user); // If this fails too, do nothing
341 user->CheckLines(true);
343 else if(iter->type == IDENT)
345 CheckIdent(user); // Nothing on failure.
346 user->CheckLines(true);
348 else if(iter->type == IDENTFIRST && !CheckIdent(user))
350 // If the ident lookup fails, try the password.
352 user->CheckLines(true);
354 else if(iter->type == WEBIRC)
356 // We don't need to do anything here
358 return MOD_RES_PASSTHRU;
361 return MOD_RES_PASSTHRU;
364 bool CheckPass(LocalUser* user)
366 if(IsValidHost(user->password))
368 HandleIdentOrPass(user, user->password, true);
369 user->password.clear();
376 bool CheckIdent(LocalUser* user)
381 if (user->ident.length() == 8)
382 ident = user->ident.c_str();
383 else if (user->ident.length() == 9 && user->ident[0] == '~')
384 ident = user->ident.c_str() + 1;
389 unsigned long ipaddr = strtoul(ident, NULL, 16);
392 newip.s_addr = htonl(ipaddr);
393 std::string newipstr(inet_ntoa(newip));
395 user->ident = "~cgiirc";
396 HandleIdentOrPass(user, newipstr, false);
401 bool IsValidHost(const std::string &host)
403 if(!host.size() || host.size() > 64)
406 for(unsigned int i = 0; i < host.size(); i++)
408 if( ((host[i] >= '0') && (host[i] <= '9')) ||
409 ((host[i] >= 'A') && (host[i] <= 'Z')) ||
410 ((host[i] >= 'a') && (host[i] <= 'z')) ||
411 ((host[i] == '-') && (i > 0) && (i+1 < host.size()) && (host[i-1] != '.') && (host[i+1] != '.')) ||
412 ((host[i] == '.') && (i > 0) && (i+1 < host.size())) )
422 virtual Version GetVersion()
424 return Version("Change user's hosts connecting from known CGI:IRC hosts",VF_VENDOR);
429 MODULE_INIT(ModuleCgiIRC)