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 works_before_reg = true;
77 this->syntax = "password client hostname ip";
79 CmdResult Handle(const std::vector<std::string> ¶meters, User *user)
81 if(user->registered == REG_ALL)
84 for(CGIHostlist::iterator iter = Hosts.begin(); iter != Hosts.end(); iter++)
86 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
88 if(iter->type == WEBIRC && parameters[0] == iter->password)
90 realhost.set(user, user->host);
91 realip.set(user, user->GetIPString());
93 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(), parameters[2].c_str(), user->host.c_str());
95 // 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
96 if (parameters[2].length() < 64)
97 webirc_hostname.set(user, parameters[2]);
99 webirc_hostname.unset(user);
101 webirc_ip.set(user, parameters[3]);
107 ServerInstance->SNO->WriteGlobalSno('a', "Connecting user %s tried to use WEBIRC, but didn't match any configured webirc blocks.", user->GetFullRealHost().c_str());
113 /** Resolver for CGI:IRC hostnames encoded in ident/GECOS
115 class CGIResolver : public Resolver
118 std::string theiruid;
119 LocalIntExt& waiting;
122 CGIResolver(Module* me, bool NotifyOpers, const std::string &source, LocalUser* u,
123 const std::string &type, bool &cached, LocalIntExt& ext)
124 : Resolver(source, DNS_QUERY_PTR4, cached, me), typ(type), theiruid(u->uuid),
125 waiting(ext), notify(NotifyOpers)
129 virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached)
131 /* Check the user still exists */
132 User* them = ServerInstance->FindUUID(theiruid);
136 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());
138 if (result.length() > 64)
141 them->dhost = result;
142 them->InvalidateCache();
143 them->CheckLines(true);
147 virtual void OnError(ResolverError e, const std::string &errormessage)
149 User* them = ServerInstance->FindUUID(theiruid);
153 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());
157 virtual ~CGIResolver()
159 User* them = ServerInstance->FindUUID(theiruid);
162 int count = waiting.get(them);
164 waiting.set(them, count - 1);
168 class ModuleCgiIRC : public Module
173 static void RecheckElineAndClass(LocalUser* user)
175 user->exempt = (ServerInstance->XLines->MatchesLine("E", user) != NULL);
180 static void ChangeIP(LocalUser* user, const std::string& newip)
182 ServerInstance->Users->RemoveCloneCounts(user);
183 user->SetClientIP(newip.c_str());
184 ServerInstance->Users->AddLocalClone(user);
185 ServerInstance->Users->AddGlobalClone(user);
188 void HandleIdentOrPass(LocalUser* user, const std::string& newip, bool was_pass)
190 cmd.realhost.set(user, user->host);
191 cmd.realip.set(user, user->GetIPString());
192 ChangeIP(user, newip);
193 user->host = user->dhost = user->GetIPString();
194 user->InvalidateCache();
195 RecheckElineAndClass(user);
196 // Don't create the resolver if the core couldn't put the user in a connect class
203 CGIResolver* r = new CGIResolver(this, cmd.notify, newip, user, (was_pass ? "PASS" : "IDENT"), cached, waiting);
204 ServerInstance->AddResolver(r, cached);
205 waiting.set(user, waiting.get(user) + 1);
210 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());
215 ModuleCgiIRC() : cmd(this), waiting("cgiirc-delay", this)
222 ServerInstance->AddCommand(&cmd);
223 ServerInstance->Extensions.Register(&cmd.realhost);
224 ServerInstance->Extensions.Register(&cmd.realip);
225 ServerInstance->Extensions.Register(&cmd.webirc_hostname);
226 ServerInstance->Extensions.Register(&cmd.webirc_ip);
227 ServerInstance->Extensions.Register(&waiting);
229 Implementation eventlist[] = { I_OnRehash, I_OnUserRegister, I_OnCheckReady };
230 ServerInstance->Modules->Attach(eventlist, this, 3);
233 void OnRehash(User* user)
237 // Do we send an oper notice when a CGI:IRC has their host changed?
238 cmd.notify = ServerInstance->Config->ConfValue("cgiirc")->getBool("opernotice", true);
240 ConfigTagList tags = ServerInstance->Config->ConfTags("cgihost");
241 for (ConfigIter i = tags.first; i != tags.second; ++i)
243 ConfigTag* tag = i->second;
244 std::string hostmask = tag->getString("mask"); // An allowed CGI:IRC host
245 std::string type = tag->getString("type"); // What type of user-munging we do on this host.
246 std::string password = tag->getString("password");
248 if(hostmask.length())
250 if (type == "webirc" && password.empty())
252 ServerInstance->Logs->Log("CONFIG",DEFAULT, "m_cgiirc: Missing password in config: %s", hostmask.c_str());
259 else if (type == "ident")
261 else if (type == "passfirst")
263 else if (type == "webirc")
268 ServerInstance->Logs->Log("CONFIG",DEFAULT, "m_cgiirc.so: Invalid <cgihost:type> value in config: %s, setting it to \"pass\"", type.c_str());
271 cmd.Hosts.push_back(CGIhost(hostmask, cgitype, password));
276 ServerInstance->Logs->Log("CONFIG",DEFAULT, "m_cgiirc.so: Invalid <cgihost:mask> value in config: %s", hostmask.c_str());
282 ModResult OnCheckReady(LocalUser *user)
284 if (waiting.get(user))
287 std::string *webirc_ip = cmd.webirc_ip.get(user);
289 return MOD_RES_PASSTHRU;
291 ChangeIP(user, *webirc_ip);
293 std::string* webirc_hostname = cmd.webirc_hostname.get(user);
294 user->host = user->dhost = (webirc_hostname ? *webirc_hostname : user->GetIPString());
296 RecheckElineAndClass(user);
300 user->CheckLines(true);
304 cmd.webirc_hostname.unset(user);
305 cmd.webirc_ip.unset(user);
307 return MOD_RES_PASSTHRU;
310 ModResult OnUserRegister(LocalUser* user)
312 for(CGIHostlist::iterator iter = cmd.Hosts.begin(); iter != cmd.Hosts.end(); iter++)
314 if(InspIRCd::Match(user->host, iter->hostmask, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(user->GetIPString(), iter->hostmask, ascii_case_insensitive_map))
317 if(iter->type == PASS)
319 CheckPass(user); // We do nothing if it fails so...
320 user->CheckLines(true);
322 else if(iter->type == PASSFIRST && !CheckPass(user))
324 // If the password lookup failed, try the ident
325 CheckIdent(user); // If this fails too, do nothing
326 user->CheckLines(true);
328 else if(iter->type == IDENT)
330 CheckIdent(user); // Nothing on failure.
331 user->CheckLines(true);
333 else if(iter->type == IDENTFIRST && !CheckIdent(user))
335 // If the ident lookup fails, try the password.
337 user->CheckLines(true);
339 else if(iter->type == WEBIRC)
341 // We don't need to do anything here
343 return MOD_RES_PASSTHRU;
346 return MOD_RES_PASSTHRU;
349 bool CheckPass(LocalUser* user)
351 if(IsValidHost(user->password))
353 HandleIdentOrPass(user, user->password, true);
354 user->password.clear();
361 bool CheckIdent(LocalUser* user)
366 if (user->ident.length() == 8)
367 ident = user->ident.c_str();
368 else if (user->ident.length() == 9 && user->ident[0] == '~')
369 ident = user->ident.c_str() + 1;
374 unsigned long ipaddr = strtoul(ident, NULL, 16);
377 newip.s_addr = htonl(ipaddr);
378 std::string newipstr(inet_ntoa(newip));
380 user->ident = "~cgiirc";
381 HandleIdentOrPass(user, newipstr, false);
386 bool IsValidHost(const std::string &host)
388 if(!host.size() || host.size() > 64)
391 for(unsigned int i = 0; i < host.size(); i++)
393 if( ((host[i] >= '0') && (host[i] <= '9')) ||
394 ((host[i] >= 'A') && (host[i] <= 'Z')) ||
395 ((host[i] >= 'a') && (host[i] <= 'z')) ||
396 ((host[i] == '-') && (i > 0) && (i+1 < host.size()) && (host[i-1] != '.') && (host[i+1] != '.')) ||
397 ((host[i] == '.') && (i > 0) && (i+1 < host.size())) )
407 virtual Version GetVersion()
409 return Version("Change user's hosts connecting from known CGI:IRC hosts",VF_VENDOR);
414 MODULE_INIT(ModuleCgiIRC)