1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
17 /* $ModDesc: Provides masking of user hostnames */
18 /* $ModDep: m_hash.h */
20 /** Handles user mode +x
22 class CloakUser : public ModeHandler
35 /** This function takes a domain name string and returns just the last two domain parts,
36 * or the last domain part if only two are available. Failing that it just returns what it was given.
38 * For example, if it is passed "svn.inspircd.org" it will return ".inspircd.org".
39 * If it is passed "brainbox.winbot.co.uk" it will return ".co.uk",
40 * and if it is passed "localhost.localdomain" it will return ".localdomain".
42 * This is used to ensure a significant part of the host is always cloaked (see Bug #216)
44 std::string LastTwoDomainParts(const std::string &host)
47 std::string::size_type splitdot = host.length();
49 for (std::string::size_type x = host.length() - 1; x; --x)
60 if (splitdot == host.length())
63 return host.substr(splitdot);
66 CloakUser(InspIRCd* Instance, Module* source, Module* Hash) : ModeHandler(Instance, 'x', 0, 0, false, MODETYPE_USER, false), Sender(source), HashProvider(Hash)
70 ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool)
73 return MODEACTION_DENY;
75 /* For remote clients, we dont take any action, we just allow it.
76 * The local server where they are will set their cloak instead.
77 * This is fine, as we will recieve it later.
81 dest->SetMode('x',adding);
82 return MODEACTION_ALLOW;
85 /* don't allow this user to spam modechanges */
86 dest->IncreasePenalty(5);
90 if(!dest->IsModeSet('x'))
92 /* The mode is being turned on - so attempt to
93 * allocate the user a cloaked host using a non-reversible
94 * algorithm (its simple, but its non-reversible so the
95 * simplicity doesnt really matter). This algorithm
96 * will not work if the user has only one level of domain
97 * naming in their hostname (e.g. if they are on a lan or
98 * are connecting via localhost) -- this doesnt matter much.
103 if (!dest->GetExt("cloaked_host", cloak))
105 /* Force creation of missing cloak */
106 Sender->OnUserConnect(dest);
108 if (dest->GetExt("cloaked_host", cloak))
110 dest->ChangeDisplayedHost(cloak->c_str());
111 dest->SetMode('x',true);
112 return MODEACTION_ALLOW;
118 if (dest->IsModeSet('x'))
120 /* User is removing the mode, so just restore their real host
121 * and make it match the displayed one.
123 dest->ChangeDisplayedHost(dest->host.c_str());
124 dest->SetMode('x',false);
125 return MODEACTION_ALLOW;
129 return MODEACTION_DENY;
132 std::string Cloak4(const char* ip)
134 unsigned int iv[] = { key1, key2, key3, key4 };
135 irc::sepstream seps(ip, '.');
137 std::string octet[4];
140 for (int j = 0; j < 4; j++)
142 seps.GetToken(octet[j]);
143 i[j] = atoi(octet[j].c_str());
146 octet[3] = octet[0] + "." + octet[1] + "." + octet[2] + "." + octet[3];
147 octet[2] = octet[0] + "." + octet[1] + "." + octet[2];
148 octet[1] = octet[0] + "." + octet[1];
150 /* Reset the Hash module and send it our IV */
151 HashResetRequest(Sender, HashProvider).Send();
152 HashKeyRequest(Sender, HashProvider, iv).Send();
154 /* Send the Hash module a different hex table for each octet group's Hash sum */
155 for (int k = 0; k < 4; k++)
157 HashHexRequest(Sender, HashProvider, xtab[(iv[k]+i[k]) % 4]).Send();
158 ra[k] = std::string(HashSumRequest(Sender, HashProvider, octet[k]).Send()).substr(0,6);
160 /* Stick them all together */
161 return std::string().append(ra[0]).append(".").append(ra[1]).append(".").append(ra[2]).append(".").append(ra[3]);
164 std::string Cloak6(const char* ip)
166 /* Theyre using 4in6 (YUCK). Translate as ipv4 cloak */
167 if (!strncmp(ip, "0::ffff:", 8))
168 return Cloak4(ip + 8);
170 /* If we get here, yes it really is an ipv6 ip */
171 unsigned int iv[] = { key1, key2, key3, key4 };
172 std::vector<std::string> hashies;
176 /* Reset the Hash module and send it our IV */
177 HashResetRequest(Sender, HashProvider).Send();
178 HashKeyRequest(Sender, HashProvider, iv).Send();
180 for (const char* input = ip; *input; input++)
183 if (item.length() > 7)
185 /* Send the Hash module a different hex table for each octet group's Hash sum */
186 HashHexRequest(Sender, HashProvider, xtab[(key1+rounds) % 4]).Send();
187 hashies.push_back(std::string(HashSumRequest(Sender, HashProvider, item).Send()).substr(0,8));
194 /* Send the Hash module a different hex table for each octet group's Hash sum */
195 HashHexRequest(Sender, HashProvider, xtab[(key1+rounds) % 4]).Send();
196 hashies.push_back(std::string(HashSumRequest(Sender, HashProvider, item).Send()).substr(0,8));
199 /* Stick them all together */
200 return irc::stringjoiner(":", hashies, 0, hashies.size() - 1).GetJoined();
205 ConfigReader Conf(ServerInstance);
208 /* These are *not* using the need_positive parameter of ReadInteger -
209 * that will limit the valid values to only the positive values in a
210 * signed int. Instead, accept any value that fits into an int and
211 * cast it to an unsigned int. That will, a bit oddly, give us the full
212 * spectrum of an unsigned integer. - Special */
213 key1 = key2 = key3 = key4 = 0;
214 key1 = (unsigned int) Conf.ReadInteger("cloak","key1",0,false);
215 key2 = (unsigned int) Conf.ReadInteger("cloak","key2",0,false);
216 key3 = (unsigned int) Conf.ReadInteger("cloak","key3",0,false);
217 key4 = (unsigned int) Conf.ReadInteger("cloak","key4",0,false);
218 prefix = Conf.ReadValue("cloak","prefix",0);
219 ipalways = Conf.ReadFlag("cloak", "ipalways", 0);
220 lowercase = Conf.ReadFlag("cloak", "lowercase", 0);
224 xtab[0] = "F92E45D871BCA630";
225 xtab[1] = "A1B9D80C72E653F4";
226 xtab[2] = "1ABC078934DEF562";
227 xtab[3] = "ABCDEF5678901234";
231 xtab[0] = "f92e45d871bca630";
232 xtab[1] = "a1b9d80c72e653f4";
233 xtab[2] = "1abc078934def562";
234 xtab[3] = "abcdef5678901234";
238 prefix = ServerInstance->Config->Network;
240 if (!key1 || !key2 || !key3 || !key4)
244 detail = "<cloak:key1> is not valid, it may be set to a too high/low value, or it may not exist.";
246 detail = "<cloak:key2> is not valid, it may be set to a too high/low value, or it may not exist.";
248 detail = "<cloak:key3> is not valid, it may be set to a too high/low value, or it may not exist.";
250 detail = "<cloak:key4> is not valid, it may be set to a too high/low value, or it may not exist.";
252 throw ModuleException("You have not defined cloak keys for m_cloaking!!! THIS IS INSECURE AND SHOULD BE CHECKED! - " + detail);
258 class ModuleCloaking : public Module
266 ModuleCloaking(InspIRCd* Me)
269 /* Attempt to locate the md5 service provider, bail if we can't find it */
270 HashModule = ServerInstance->Modules->Find("m_md5.so");
272 throw ModuleException("Can't find m_md5.so. Please load m_md5.so before m_cloaking.so.");
274 cu = new CloakUser(ServerInstance, this, HashModule);
280 catch (ModuleException &e)
286 /* Register it with the core */
287 if (!ServerInstance->Modes->AddMode(cu))
290 throw ModuleException("Could not add new modes!");
293 ServerInstance->Modules->UseInterface("HashRequest");
295 Implementation eventlist[] = { I_OnRehash, I_OnUserDisconnect, I_OnCleanup, I_OnCheckBan, I_OnUserConnect, I_OnSyncUserMetaData, I_OnCleanup };
296 ServerInstance->Modules->Attach(eventlist, this, 6);
298 CloakExistingUsers();
301 void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable)
303 if ((displayable) && (extname == "cloaked_host"))
306 if (user->GetExt("cloaked_host", cloak))
307 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, *cloak);
311 void CloakExistingUsers()
314 for (std::vector<User*>::iterator u = ServerInstance->Users->local_users.begin(); u != ServerInstance->Users->local_users.end(); u++)
316 if (!(*u)->GetExt("cloaked_host", cloak))
323 virtual int OnCheckBan(User* user, Channel* chan)
327 /* Check if they have a cloaked host, but are not using it */
328 if (user->GetExt("cloaked_host", tofree) && *tofree != user->dhost)
330 snprintf(mask, MAXBUF, "%s!%s@%s", user->nick.c_str(), user->ident.c_str(), tofree->c_str());
331 for (BanList::iterator i = chan->bans.begin(); i != chan->bans.end(); i++)
333 if (InspIRCd::Match(mask,i->data))
342 /* Needs to be after m_banexception etc. */
343 ServerInstance->Modules->SetPriority(this, I_OnCheckBan, PRIO_LAST);
345 /* but before m_conn_umodes, so host is generated ready to apply */
346 Module *um = ServerInstance->Modules->Find("m_conn_umodes.so");
347 ServerInstance->Modules->SetPriority(this, I_OnUserConnect, PRIO_AFTER, &um);
350 virtual void OnUserDisconnect(User* user)
353 if (user->GetExt("cloaked_host", tofree))
356 user->Shrink("cloaked_host");
360 virtual void OnCleanup(int target_type, void* item)
362 if (target_type == TYPE_USER)
363 OnUserDisconnect((User*)item);
366 virtual ~ModuleCloaking()
368 ServerInstance->Modes->DelMode(cu);
370 ServerInstance->Modules->DoneWithInterface("HashRequest");
373 virtual Version GetVersion()
375 // returns the version number of the module to be
376 // listed in /MODULES
377 return Version("$Id$", VF_COMMON|VF_VENDOR,API_VERSION);
380 virtual void OnRehash(User* user, const std::string ¶meter)
385 virtual void OnUserConnect(User* dest)
388 if (dest->GetExt("cloaked_host", tofree))
391 if (dest->host.find('.') != std::string::npos || dest->host.find(':') != std::string::npos)
393 unsigned int iv[] = { cu->key1, cu->key2, cu->key3, cu->key4 };
394 std::string a = cu->LastTwoDomainParts(dest->host);
397 /* InspIRCd users have two hostnames; A displayed
398 * hostname which can be modified by modules (e.g.
399 * to create vhosts, implement chghost, etc) and a
400 * 'real' hostname which you shouldnt write to.
403 /* 2008/08/18: add <cloak:ipalways> which always cloaks
404 * the IP, for anonymity. --nenolod
408 /** Reset the Hash module, and send it our IV and hex table */
409 HashResetRequest(this, cu->HashProvider).Send();
410 HashKeyRequest(this, cu->HashProvider, iv).Send();
411 HashHexRequest(this, cu->HashProvider, cu->xtab[(dest->host[0]) % 4]);
413 /* Generate a cloak using specialized Hash */
414 std::string hostcloak = cu->prefix + "-" + std::string(HashSumRequest(this, cu->HashProvider, dest->host.c_str()).Send()).substr(0,8) + a;
416 /* Fix by brain - if the cloaked host is > the max length of a host (64 bytes
417 * according to the DNS RFC) then tough titty, they get cloaked as an IP.
418 * Their ISP shouldnt go to town on subdomains, or they shouldnt have a kiddie
424 if ((dest->GetProtocolFamily() == AF_INET6) && (inet_pton(AF_INET6,dest->host.c_str(),&testaddr) < 1) && (hostcloak.length() <= 64))
425 /* Invalid ipv6 address, and ipv6 user (resolved host) */
427 else if ((dest->GetProtocolFamily() == AF_INET) && (inet_aton(dest->host.c_str(),&testaddr2) < 1) && (hostcloak.length() <= 64))
428 /* Invalid ipv4 address, and ipv4 user (resolved host) */
431 /* Valid ipv6 or ipv4 address (not resolved) ipv4 or ipv6 user */
432 b = ((!strchr(dest->host.c_str(),':')) ? cu->Cloak4(dest->host.c_str()) : cu->Cloak6(dest->host.c_str()));
435 if ((inet_aton(dest->host.c_str(),&testaddr) < 1) && (hostcloak.length() <= 64))
436 /* Invalid ipv4 address, and ipv4 user (resolved host) */
439 /* Valid ipv4 address (not resolved) ipv4 user */
440 b = cu->Cloak4(dest->host.c_str());
446 if (dest->GetProtocolFamily() == AF_INET6)
447 b = cu->Cloak6(dest->GetIPString());
449 if (dest->GetProtocolFamily() == AF_INET)
450 b = cu->Cloak4(dest->GetIPString());
453 dest->Extend("cloaked_host", new std::string(b));
459 MODULE_INIT(ModuleCloaking)