src/usermanager.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Dennis Friis <peavey@inspircd.org>
   6  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   7  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24 #include "xline.h"
  25 #include "iohook.h"
  26
  27 namespace
  28 {
  29         class WriteCommonQuit : public User::ForEachNeighborHandler
  30         {
  31                 ClientProtocol::Messages::Quit quitmsg;
  32                 ClientProtocol::Event quitevent;
  33                 ClientProtocol::Messages::Quit operquitmsg;
  34                 ClientProtocol::Event operquitevent;
  35
  36                 void Execute(LocalUser* user) CXX11_OVERRIDE
  37                 {
  38                         user->Send(user->IsOper() ? operquitevent : quitevent);
  39                 }
  40
  41          public:
  42                 WriteCommonQuit(User* user, const std::string& msg, const std::string& opermsg)
  43                         : quitmsg(user, msg)
  44                         , quitevent(ServerInstance->GetRFCEvents().quit, quitmsg)
  45                         , operquitmsg(user, opermsg)
  46                         , operquitevent(ServerInstance->GetRFCEvents().quit, operquitmsg)
  47                 {
  48                         user->ForEachNeighbor(*this, false);
  49                 }
  50         };
  51 }
  52
  53 UserManager::UserManager()
  54         : already_sent_id(0)
  55         , unregistered_count(0)
  56 {
  57 }
  58
  59 UserManager::~UserManager()
  60 {
  61         for (user_hash::iterator i = clientlist.begin(); i != clientlist.end(); ++i)
  62         {
  63                 delete i->second;
  64         }
  65 }
  66
  67 void UserManager::AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
  68 {
  69         // User constructor allocates a new UUID for the user and inserts it into the uuidlist
  70         LocalUser* const New = new LocalUser(socket, client, server);
  71         UserIOHandler* eh = &New->eh;
  72
  73         ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New user fd: %d", socket);
  74
  75         this->unregistered_count++;
  76         this->clientlist[New->nick] = New;
  77         this->AddClone(New);
  78         this->local_users.push_front(New);
  79
  80         if (!SocketEngine::AddFd(eh, FD_WANT_FAST_READ | FD_WANT_EDGE_WRITE))
  81         {
  82                 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "Internal error on new connection");
  83                 this->QuitUser(New, "Internal error handling connection");
  84                 return;
  85         }
  86
  87         // If this listener has an IO hook provider set then tell it about the connection
  88         for (ListenSocket::IOHookProvList::iterator i = via->iohookprovs.begin(); i != via->iohookprovs.end(); ++i)
  89         {
  90                 ListenSocket::IOHookProvRef& iohookprovref = *i;
  91                 if (!iohookprovref)
  92                         continue;
  93
  94                 iohookprovref->OnAccept(eh, client, server);
  95                 // IOHook could have encountered a fatal error, e.g. if the TLS ClientHello was already in the queue and there was no common TLS version
  96                 if (!eh->getError().empty())
  97                 {
  98                         QuitUser(New, eh->getError());
  99                         return;
 100                 }
 101         }
 102
 103         if (this->local_users.size() > ServerInstance->Config->SoftLimit)
 104         {
 105                 ServerInstance->SNO->WriteToSnoMask('a', "Warning: softlimit value has been reached: %d clients", ServerInstance->Config->SoftLimit);
 106                 this->QuitUser(New,"No more connections allowed");
 107                 return;
 108         }
 109
 110         // First class check. We do this again in LocalUser::FullConnect() after DNS is done, and NICK/USER is received.
 111         New->SetClass();
 112         // If the user doesn't have an acceptable connect class CheckClass() quits them
 113         New->CheckClass(ServerInstance->Config->CCOnConnect);
 114         if (New->quitting)
 115                 return;
 116
 117         /*
 118          * even with bancache, we still have to keep User::exempt current.
 119          * besides that, if we get a positive bancache hit, we still won't fuck
 120          * them over if they are exempt. -- w00t
 121          */
 122         New->exempt = (ServerInstance->XLines->MatchesLine("E",New) != NULL);
 123
 124         BanCacheHit* const b = ServerInstance->BanCache.GetHit(New->GetIPString());
 125         if (b)
 126         {
 127                 if (!b->Type.empty() && !New->exempt)
 128                 {
 129                         /* user banned */
 130                         ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Positive hit for " + New->GetIPString());
 131                         if (!ServerInstance->Config->XLineMessage.empty())
 132                                 New->WriteNumeric(ERR_YOUREBANNEDCREEP, ServerInstance->Config->XLineMessage);
 133
 134                         if (ServerInstance->Config->HideBans)
 135                                 this->QuitUser(New, b->Type + "-lined", &b->Reason);
 136                         else
 137                                 this->QuitUser(New, b->Reason);
 138                         return;
 139                 }
 140                 else
 141                 {
 142                         ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Negative hit for " + New->GetIPString());
 143                 }
 144         }
 145         else
 146         {
 147                 if (!New->exempt)
 148                 {
 149                         XLine* r = ServerInstance->XLines->MatchesLine("Z",New);
 150
 151                         if (r)
 152                         {
 153                                 r->Apply(New);
 154                                 return;
 155                         }
 156                 }
 157         }
 158
 159         if (ServerInstance->Config->RawLog)
 160                 New->WriteNotice("*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.");
 161
 162         FOREACH_MOD(OnSetUserIP, (New));
 163         if (New->quitting)
 164                 return;
 165
 166         FOREACH_MOD(OnUserInit, (New));
 167 }
 168
 169 void UserManager::QuitUser(User* user, const std::string& quitreason, const std::string* operreason)
 170 {
 171         if (user->quitting)
 172         {
 173                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Tried to quit quitting user: " + user->nick);
 174                 return;
 175         }
 176
 177         if (IS_SERVER(user))
 178         {
 179                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Tried to quit server user: " + user->nick);
 180                 return;
 181         }
 182
 183         user->quitting = true;
 184
 185         ServerInstance->Logs->Log("USERS", LOG_DEBUG, "QuitUser: %s=%s '%s'", user->uuid.c_str(), user->nick.c_str(), quitreason.c_str());
 186         LocalUser* const localuser = IS_LOCAL(user);
 187         if (localuser)
 188         {
 189                 ClientProtocol::Messages::Error errormsg(InspIRCd::Format("Closing link: (%s@%s) [%s]", user->ident.c_str(), user->GetRealHost().c_str(), operreason ? operreason->c_str() : quitreason.c_str()));
 190                 localuser->Send(ServerInstance->GetRFCEvents().error, errormsg);
 191         }
 192
 193         std::string reason;
 194         reason.assign(quitreason, 0, ServerInstance->Config->Limits.MaxQuit);
 195         if (!operreason)
 196                 operreason = &reason;
 197
 198         ServerInstance->GlobalCulls.AddItem(user);
 199
 200         if (user->registered == REG_ALL)
 201         {
 202                 FOREACH_MOD(OnUserQuit, (user, reason, *operreason));
 203                 WriteCommonQuit(user, reason, *operreason);
 204         }
 205         else
 206                 unregistered_count--;
 207
 208         if (IS_LOCAL(user))
 209         {
 210                 LocalUser* lu = IS_LOCAL(user);
 211                 FOREACH_MOD(OnUserDisconnect, (lu));
 212                 lu->eh.Close();
 213
 214                 if (lu->registered == REG_ALL)
 215                         ServerInstance->SNO->WriteToSnoMask('q',"Client exiting: %s (%s) [%s]", user->GetFullRealHost().c_str(), user->GetIPString().c_str(), operreason->c_str());
 216                 local_users.erase(lu);
 217         }
 218
 219         if (!clientlist.erase(user->nick))
 220                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Nick not found in clientlist, cannot remove: " + user->nick);
 221
 222         uuidlist.erase(user->uuid);
 223         user->PurgeEmptyChannels();
 224         user->UnOper();
 225 }
 226
 227 void UserManager::AddClone(User* user)
 228 {
 229         CloneCounts& counts = clonemap[user->GetCIDRMask()];
 230         counts.global++;
 231         if (IS_LOCAL(user))
 232                 counts.local++;
 233 }
 234
 235 void UserManager::RemoveCloneCounts(User *user)
 236 {
 237         CloneMap::iterator it = clonemap.find(user->GetCIDRMask());
 238         if (it != clonemap.end())
 239         {
 240                 CloneCounts& counts = it->second;
 241                 counts.global--;
 242                 if (counts.global == 0)
 243                 {
 244                         // No more users from this IP, remove entry from the map
 245                         clonemap.erase(it);
 246                         return;
 247                 }
 248
 249                 if (IS_LOCAL(user))
 250                         counts.local--;
 251         }
 252 }
 253
 254 void UserManager::RehashCloneCounts()
 255 {
 256         clonemap.clear();
 257
 258         const user_hash& hash = ServerInstance->Users.GetUsers();
 259         for (user_hash::const_iterator i = hash.begin(); i != hash.end(); ++i)
 260         {
 261                 User* u = i->second;
 262                 AddClone(u);
 263         }
 264 }
 265
 266 const UserManager::CloneCounts& UserManager::GetCloneCounts(User* user) const
 267 {
 268         CloneMap::const_iterator it = clonemap.find(user->GetCIDRMask());
 269         if (it != clonemap.end())
 270                 return it->second;
 271         else
 272                 return zeroclonecounts;
 273 }
 274
 275 void UserManager::ServerNoticeAll(const char* text, ...)
 276 {
 277         std::string message;
 278         VAFORMAT(message, text, text);
 279         ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, ServerInstance->FakeClient, ServerInstance->Config->ServerName, message, MSG_NOTICE);
 280         ClientProtocol::Event msgevent(ServerInstance->GetRFCEvents().privmsg, msg);
 281
 282         for (LocalList::const_iterator i = local_users.begin(); i != local_users.end(); ++i)
 283         {
 284                 LocalUser* user = *i;
 285                 user->Send(msgevent);
 286         }
 287 }
 288
 289 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
 290  * (until this returns true, a user will block in the waiting state, waiting to connect up to the
 291  * registration timeout maximum seconds)
 292  */
 293 bool UserManager::AllModulesReportReady(LocalUser* user)
 294 {
 295         ModResult res;
 296         FIRST_MOD_RESULT(OnCheckReady, res, (user));
 297         return (res == MOD_RES_PASSTHRU);
 298 }
 299
 300 /**
 301  * This function is called once a second from the mainloop.
 302  * It is intended to do background checking on all the users, e.g. do
 303  * ping checks, registration timeouts, etc.
 304  */
 305 void UserManager::DoBackgroundUserStuff()
 306 {
 307         for (LocalList::iterator i = local_users.begin(); i != local_users.end(); )
 308         {
 309                 // It's possible that we quit the user below due to ping timeout etc. and QuitUser() removes it from the list
 310                 LocalUser* curr = *i;
 311                 ++i;
 312
 313                 if (curr->CommandFloodPenalty || curr->eh.getSendQSize())
 314                 {
 315                         unsigned int rate = curr->MyClass->GetCommandRate();
 316                         if (curr->CommandFloodPenalty > rate)
 317                                 curr->CommandFloodPenalty -= rate;
 318                         else
 319                                 curr->CommandFloodPenalty = 0;
 320                         curr->eh.OnDataReady();
 321                 }
 322
 323                 switch (curr->registered)
 324                 {
 325                         case REG_ALL:
 326                                 if (ServerInstance->Time() >= curr->nping)
 327                                 {
 328                                         // This user didn't answer the last ping, remove them
 329                                         if (!curr->lastping)
 330                                         {
 331                                                 time_t time = ServerInstance->Time() - (curr->nping - curr->MyClass->GetPingTime());
 332                                                 const std::string message = "Ping timeout: " + ConvToStr(time) + (time != 1 ? " seconds" : " second");
 333                                                 this->QuitUser(curr, message);
 334                                                 continue;
 335                                         }
 336                                         ClientProtocol::Messages::Ping ping;
 337                                         curr->Send(ServerInstance->GetRFCEvents().ping, ping);
 338                                         curr->lastping = 0;
 339                                         curr->nping = ServerInstance->Time() + curr->MyClass->GetPingTime();
 340                                 }
 341                                 break;
 342                         case REG_NICKUSER:
 343                                 if (AllModulesReportReady(curr))
 344                                 {
 345                                         /* User has sent NICK/USER, modules are okay, DNS finished. */
 346                                         curr->FullConnect();
 347                                         continue;
 348                                 }
 349
 350                                 // If the user has been quit in OnCheckReady then we shouldn't
 351                                 // quit them again for having a registration timeout.
 352                                 if (curr->quitting)
 353                                         continue;
 354                                 break;
 355                 }
 356
 357                 if (curr->registered != REG_ALL && curr->MyClass && (ServerInstance->Time() > (curr->signon + curr->MyClass->GetRegTimeout())))
 358                 {
 359                         /*
 360                          * registration timeout -- didnt send USER/NICK/HOST
 361                          * in the time specified in their connection class.
 362                          */
 363                         this->QuitUser(curr, "Registration timeout");
 364                         continue;
 365                 }
 366         }
 367 }
 368
 369 already_sent_t UserManager::NextAlreadySentId()
 370 {
 371         if (++already_sent_id == 0)
 372         {
 373                 // Wrapped around, reset the already_sent ids of all users
 374                 already_sent_id = 1;
 375                 for (LocalList::iterator i = local_users.begin(); i != local_users.end(); ++i)
 376                 {
 377                         LocalUser* user = *i;
 378                         user->already_sent = 0;
 379                 }
 380         }
 381         return already_sent_id;
 382 }