2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
7 * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2007 John Brooks <john.brooks@dereferenced.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/>.
27 #include "modules/hash.h"
31 /** 2.0 cloak of "half" of the hostname plus the full IP hash */
33 /** 2.0 cloak of IP hash, split at 2 common CIDR range points */
37 // lowercase-only encoding similar to base64, used for hash output
38 static const char base32[] = "0123456789abcdefghijklmnopqrstuv";
40 /** Handles user mode +x
42 class CloakUser : public ModeHandler
46 std::string debounce_uid;
50 CloakUser(Module* source)
51 : ModeHandler(source, "cloak", 'x', PARAM_NONE, MODETYPE_USER),
52 ext("cloaked_host", source), debounce_ts(0), debounce_count(0)
56 ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
58 LocalUser* user = IS_LOCAL(dest);
60 /* For remote clients, we don't take any action, we just allow it.
61 * The local server where they are will set their cloak instead.
62 * This is fine, as we will receive it later.
66 dest->SetMode(this, adding);
67 return MODEACTION_ALLOW;
70 if (user->uuid == debounce_uid && debounce_ts == ServerInstance->Time())
72 // prevent spamming using /mode user +x-x+x-x+x-x
73 if (++debounce_count > 2)
74 return MODEACTION_DENY;
78 debounce_uid = user->uuid;
80 debounce_ts = ServerInstance->Time();
83 if (adding == user->IsModeSet(this))
84 return MODEACTION_DENY;
86 /* don't allow this user to spam modechanges */
88 user->CommandFloodPenalty += 5000;
92 std::string* cloak = ext.get(user);
96 /* Force creation of missing cloak */
97 creator->OnUserConnect(user);
98 cloak = ext.get(user);
102 user->ChangeDisplayedHost(cloak->c_str());
103 user->SetMode(this, true);
104 return MODEACTION_ALLOW;
107 return MODEACTION_DENY;
111 /* User is removing the mode, so restore their real host
112 * and make it match the displayed one.
114 user->SetMode(this, false);
115 user->ChangeDisplayedHost(user->host.c_str());
116 return MODEACTION_ALLOW;
121 class CommandCloak : public Command
124 CommandCloak(Module* Creator) : Command(Creator, "CLOAK", 1)
130 CmdResult Handle(const std::vector<std::string> ¶meters, User *user);
133 class ModuleCloaking : public Module
143 dynamic_reference<HashProvider> Hash;
145 ModuleCloaking() : cu(this), mode(MODE_OPAQUE), ck(this), Hash(this, "hash/md5")
149 /** This function takes a domain name string and returns just the last two domain parts,
150 * or the last domain part if only two are available. Failing that it just returns what it was given.
152 * For example, if it is passed "svn.inspircd.org" it will return ".inspircd.org".
153 * If it is passed "brainbox.winbot.co.uk" it will return ".co.uk",
154 * and if it is passed "localhost.localdomain" it will return ".localdomain".
156 * This is used to ensure a significant part of the host is always cloaked (see Bug #216)
158 std::string LastTwoDomainParts(const std::string &host)
161 std::string::size_type splitdot = host.length();
163 for (std::string::size_type x = host.length() - 1; x; --x)
174 if (splitdot == host.length())
177 return host.substr(splitdot);
181 * 2.0-style cloaking function
182 * @param item The item to cloak (part of an IP or hostname)
183 * @param id A unique ID for this type of item (to make it unique if the item matches)
184 * @param len The length of the output. Maximum for MD5 is 16 characters.
186 std::string SegmentCloak(const std::string& item, char id, int len)
189 input.reserve(key.length() + 3 + item.length());
192 input.append(1, '\0'); // null does not terminate a C++ string
195 std::string rv = Hash->sum(input).substr(0,len);
196 for(int i=0; i < len; i++)
198 // this discards 3 bits per byte. We have an
199 // overabundance of bits in the hash output, doesn't
200 // matter which ones we are discarding.
201 rv[i] = base32[rv[i] & 0x1F];
206 std::string SegmentIP(const irc::sockets::sockaddrs& ip, bool full)
209 int hop1, hop2, hop3;
212 if (ip.sa.sa_family == AF_INET6)
214 bindata = std::string((const char*)ip.in6.sin6_addr.s6_addr, 16);
220 // pfx s1.s2.s3. (xxxx.xxxx or s4) sfx
222 rv.reserve(prefix.length() + 26 + suffix.length());
226 bindata = std::string((const char*)&ip.in4.sin_addr, 4);
231 // pfx s1.s2. (xxx.xxx or s3) sfx
232 rv.reserve(prefix.length() + 15 + suffix.length());
236 rv.append(SegmentCloak(bindata, 10, len1));
239 rv.append(SegmentCloak(bindata, 11, len2));
244 rv.append(SegmentCloak(bindata, 12, len2));
251 rv.append(SegmentCloak(bindata, 13, 6));
257 if (ip.sa.sa_family == AF_INET6)
259 snprintf(buf, 50, ".%02x%02x.%02x%02x%s",
260 ip.in6.sin6_addr.s6_addr[2], ip.in6.sin6_addr.s6_addr[3],
261 ip.in6.sin6_addr.s6_addr[0], ip.in6.sin6_addr.s6_addr[1], suffix.c_str());
265 const unsigned char* ip4 = (const unsigned char*)&ip.in4.sin_addr;
266 snprintf(buf, 50, ".%d.%d%s", ip4[1], ip4[0], suffix.c_str());
273 ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask) CXX11_OVERRIDE
275 LocalUser* lu = IS_LOCAL(user);
277 return MOD_RES_PASSTHRU;
280 std::string* cloak = cu.ext.get(user);
281 /* Check if they have a cloaked host, but are not using it */
282 if (cloak && *cloak != user->dhost)
284 const std::string cloakMask = user->nick + "!" + user->ident + "@" + *cloak;
285 if (InspIRCd::Match(cloakMask, mask))
288 return MOD_RES_PASSTHRU;
293 /* Needs to be after m_banexception etc. */
294 ServerInstance->Modules->SetPriority(this, I_OnCheckBan, PRIORITY_LAST);
297 // this unsets umode +x on every host change. If we are actually doing a +x
298 // mode change, we will call SetMode back to true AFTER the host change is done.
299 void OnChangeHost(User* u, const std::string& host) CXX11_OVERRIDE
301 if (u->IsModeSet(cu))
303 u->SetMode(cu, false);
304 u->WriteServ("MODE %s -%c", u->nick.c_str(), cu.GetModeChar());
308 Version GetVersion() CXX11_OVERRIDE
310 std::string testcloak = "broken";
315 case MODE_HALF_CLOAK:
316 testcloak = prefix + SegmentCloak("*", 3, 8) + suffix;
319 testcloak = prefix + SegmentCloak("*", 4, 8) + suffix;
322 return Version("Provides masking of user hostnames", VF_COMMON|VF_VENDOR, testcloak);
325 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
327 ConfigTag* tag = ServerInstance->Config->ConfValue("cloak");
328 prefix = tag->getString("prefix");
329 suffix = tag->getString("suffix", ".IP");
331 std::string modestr = tag->getString("mode");
332 if (modestr == "half")
333 mode = MODE_HALF_CLOAK;
334 else if (modestr == "full")
337 throw ModuleException("Bad value for <cloak:mode>; must be half or full");
339 key = tag->getString("key");
340 if (key.empty() || key == "secret")
341 throw ModuleException("You have not defined cloak keys for m_cloaking. Define <cloak:key> as a network-wide secret.");
344 std::string GenCloak(const irc::sockets::sockaddrs& ip, const std::string& ipstr, const std::string& host)
350 case MODE_HALF_CLOAK:
353 chost = prefix + SegmentCloak(host, 1, 6) + LastTwoDomainParts(host);
354 if (chost.empty() || chost.length() > 50)
355 chost = SegmentIP(ip, false);
360 chost = SegmentIP(ip, true);
365 void OnUserConnect(LocalUser* dest) CXX11_OVERRIDE
367 std::string* cloak = cu.ext.get(dest);
371 cu.ext.set(dest, GenCloak(dest->client_sa, dest->GetIPString(), dest->host));
375 CmdResult CommandCloak::Handle(const std::vector<std::string> ¶meters, User *user)
377 ModuleCloaking* mod = (ModuleCloaking*)(Module*)creator;
378 irc::sockets::sockaddrs sa;
381 if (irc::sockets::aptosa(parameters[0], 0, sa))
382 cloak = mod->GenCloak(sa, parameters[0], parameters[0]);
384 cloak = mod->GenCloak(sa, "", parameters[0]);
386 user->WriteNotice("*** Cloak for " + parameters[0] + " is " + cloak);
391 MODULE_INIT(ModuleCloaking)