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", ExtensionItem::EXT_USER, 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 // assume this is more correct
93 if (user->registered != REG_ALL && user->host != user->dhost)
94 return MODEACTION_DENY;
96 std::string* cloak = ext.get(user);
100 /* Force creation of missing cloak */
101 creator->OnUserConnect(user);
102 cloak = ext.get(user);
106 user->ChangeDisplayedHost(*cloak);
107 user->SetMode(this, true);
108 return MODEACTION_ALLOW;
111 return MODEACTION_DENY;
115 /* User is removing the mode, so restore their real host
116 * and make it match the displayed one.
118 user->SetMode(this, false);
119 user->ChangeDisplayedHost(user->host.c_str());
120 return MODEACTION_ALLOW;
125 class CommandCloak : public Command
128 CommandCloak(Module* Creator) : Command(Creator, "CLOAK", 1)
134 CmdResult Handle(const std::vector<std::string> ¶meters, User *user);
137 class ModuleCloaking : public Module
146 unsigned int domainparts;
147 dynamic_reference<HashProvider> Hash;
149 ModuleCloaking() : cu(this), mode(MODE_OPAQUE), ck(this), Hash(this, "hash/md5")
153 /** This function takes a domain name string and returns just the last two domain parts,
154 * or the last domain part if only two are available. Failing that it just returns what it was given.
156 * For example, if it is passed "svn.inspircd.org" it will return ".inspircd.org".
157 * If it is passed "brainbox.winbot.co.uk" it will return ".co.uk",
158 * and if it is passed "localhost.localdomain" it will return ".localdomain".
160 * This is used to ensure a significant part of the host is always cloaked (see Bug #216)
162 std::string LastTwoDomainParts(const std::string &host)
164 unsigned int dots = 0;
165 std::string::size_type splitdot = host.length();
167 for (std::string::size_type x = host.length() - 1; x; --x)
174 if (dots >= domainparts)
178 if (splitdot == host.length())
181 return host.substr(splitdot);
185 * 2.0-style cloaking function
186 * @param item The item to cloak (part of an IP or hostname)
187 * @param id A unique ID for this type of item (to make it unique if the item matches)
188 * @param len The length of the output. Maximum for MD5 is 16 characters.
190 std::string SegmentCloak(const std::string& item, char id, int len)
193 input.reserve(key.length() + 3 + item.length());
196 input.append(1, '\0'); // null does not terminate a C++ string
199 std::string rv = Hash->GenerateRaw(input).substr(0,len);
200 for(int i=0; i < len; i++)
202 // this discards 3 bits per byte. We have an
203 // overabundance of bits in the hash output, doesn't
204 // matter which ones we are discarding.
205 rv[i] = base32[rv[i] & 0x1F];
210 std::string SegmentIP(const irc::sockets::sockaddrs& ip, bool full)
213 int hop1, hop2, hop3;
216 if (ip.sa.sa_family == AF_INET6)
218 bindata = std::string((const char*)ip.in6.sin6_addr.s6_addr, 16);
224 // pfx s1.s2.s3. (xxxx.xxxx or s4) sfx
226 rv.reserve(prefix.length() + 26 + suffix.length());
230 bindata = std::string((const char*)&ip.in4.sin_addr, 4);
235 // pfx s1.s2. (xxx.xxx or s3) sfx
236 rv.reserve(prefix.length() + 15 + suffix.length());
240 rv.append(SegmentCloak(bindata, 10, len1));
243 rv.append(SegmentCloak(bindata, 11, len2));
248 rv.append(SegmentCloak(bindata, 12, len2));
255 rv.append(SegmentCloak(bindata, 13, 6));
260 if (ip.sa.sa_family == AF_INET6)
262 rv.append(InspIRCd::Format(".%02x%02x.%02x%02x%s",
263 ip.in6.sin6_addr.s6_addr[2], ip.in6.sin6_addr.s6_addr[3],
264 ip.in6.sin6_addr.s6_addr[0], ip.in6.sin6_addr.s6_addr[1], suffix.c_str()));
268 const unsigned char* ip4 = (const unsigned char*)&ip.in4.sin_addr;
269 rv.append(InspIRCd::Format(".%d.%d%s", ip4[1], ip4[0], suffix.c_str()));
275 ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask) CXX11_OVERRIDE
277 LocalUser* lu = IS_LOCAL(user);
279 return MOD_RES_PASSTHRU;
282 std::string* cloak = cu.ext.get(user);
283 /* Check if they have a cloaked host, but are not using it */
284 if (cloak && *cloak != user->dhost)
286 const std::string cloakMask = user->nick + "!" + user->ident + "@" + *cloak;
287 if (InspIRCd::Match(cloakMask, mask))
290 return MOD_RES_PASSTHRU;
293 void Prioritize() CXX11_OVERRIDE
295 /* Needs to be after m_banexception etc. */
296 ServerInstance->Modules->SetPriority(this, I_OnCheckBan, PRIORITY_LAST);
299 // this unsets umode +x on every host change. If we are actually doing a +x
300 // mode change, we will call SetMode back to true AFTER the host change is done.
301 void OnChangeHost(User* u, const std::string& host) CXX11_OVERRIDE
303 if (u->IsModeSet(cu))
305 u->SetMode(cu, false);
306 u->WriteCommand("MODE", "-" + ConvToStr(cu.GetModeChar()));
310 Version GetVersion() CXX11_OVERRIDE
312 std::string testcloak = "broken";
317 case MODE_HALF_CLOAK:
318 // Use old cloaking verification to stay compatible with 2.0
319 // But verify domainparts when use 3.0-only features
320 if (domainparts == 3)
321 testcloak = prefix + SegmentCloak("*", 3, 8) + suffix;
324 irc::sockets::sockaddrs sa;
325 testcloak = GenCloak(sa, "", testcloak + ConvToStr(domainparts));
329 testcloak = prefix + SegmentCloak("*", 4, 8) + suffix;
332 return Version("Provides masking of user hostnames", VF_COMMON|VF_VENDOR, testcloak);
335 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
337 ConfigTag* tag = ServerInstance->Config->ConfValue("cloak");
338 prefix = tag->getString("prefix");
339 suffix = tag->getString("suffix", ".IP");
341 std::string modestr = tag->getString("mode");
342 if (modestr == "half")
344 mode = MODE_HALF_CLOAK;
345 domainparts = tag->getInt("domainparts", 3, 1, 10);
347 else if (modestr == "full")
350 throw ModuleException("Bad value for <cloak:mode>; must be half or full");
352 key = tag->getString("key");
353 if (key.empty() || key == "secret")
354 throw ModuleException("You have not defined cloak keys for m_cloaking. Define <cloak:key> as a network-wide secret.");
357 std::string GenCloak(const irc::sockets::sockaddrs& ip, const std::string& ipstr, const std::string& host)
361 irc::sockets::sockaddrs hostip;
362 bool host_is_ip = irc::sockets::aptosa(host, ip.port(), hostip) && hostip == ip;
366 case MODE_HALF_CLOAK:
369 chost = prefix + SegmentCloak(host, 1, 6) + LastTwoDomainParts(host);
370 if (chost.empty() || chost.length() > 50)
371 chost = SegmentIP(ip, false);
376 chost = SegmentIP(ip, true);
381 void OnUserConnect(LocalUser* dest) CXX11_OVERRIDE
383 std::string* cloak = cu.ext.get(dest);
387 cu.ext.set(dest, GenCloak(dest->client_sa, dest->GetIPString(), dest->host));
391 CmdResult CommandCloak::Handle(const std::vector<std::string> ¶meters, User *user)
393 ModuleCloaking* mod = (ModuleCloaking*)(Module*)creator;
394 irc::sockets::sockaddrs sa;
397 if (irc::sockets::aptosa(parameters[0], 0, sa))
398 cloak = mod->GenCloak(sa, parameters[0], parameters[0]);
400 cloak = mod->GenCloak(sa, "", parameters[0]);
402 user->WriteNotice("*** Cloak for " + parameters[0] + " is " + cloak);
407 MODULE_INIT(ModuleCloaking)