src/modules/m_ident.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007, 2009 John Brooks <john.brooks@dereferenced.net>
   6  *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
   7  *   Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   9  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  10  *
  11  * This file is part of InspIRCd.  InspIRCd is free software: you can
  12  * redistribute it and/or modify it under the terms of the GNU General Public
  13  * License as published by the Free Software Foundation, version 2.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24
  25 #include "inspircd.h"
  26
  27 /* --------------------------------------------------------------
  28  * Note that this is the third incarnation of m_ident. The first
  29  * two attempts were pretty crashy, mainly due to the fact we tried
  30  * to use InspSocket/BufferedSocket to make them work. This class
  31  * is ok for more heavyweight tasks, it does a lot of things behind
  32  * the scenes that are not good for ident sockets and it has a huge
  33  * memory footprint!
  34  *
  35  * To fix all the issues that we had in the old ident modules (many
  36  * nasty race conditions that would cause segfaults etc) we have
  37  * rewritten this module to use a simplified socket object based
  38  * directly off EventHandler. As EventHandler only has low level
  39  * readability, writeability and error events tied directly to the
  40  * socket engine, this makes our lives easier as nothing happens to
  41  * our ident lookup class that is outside of this module, or out-
  42  * side of the control of the class. There are no timers, internal
  43  * events, or such, which will cause the socket to be deleted,
  44  * queued for deletion, etc. In fact, theres not even any queueing!
  45  *
  46  * Using this framework we have a much more stable module.
  47  *
  48  * A few things to note:
  49  *
  50  *   O  The only place that may *delete* an active or inactive
  51  *      ident socket is OnUserDisconnect in the module class.
  52  *      Because this is out of scope of the socket class there is
  53  *      no possibility that the socket may ever try to delete
  54  *      itself.
  55  *
  56  *   O  Closure of the ident socket with the Close() method will
  57  *      not cause removal of the socket from memory or detatchment
  58  *      from its 'parent' User class. It will only flag it as an
  59  *      inactive socket in the socket engine.
  60  *
  61  *   O  Timeouts are handled in OnCheckReaady at the same time as
  62  *      checking if the ident socket has a result. This is done
  63  *      by checking if the age the of the class (its instantiation
  64  *      time) plus the timeout value is greater than the current time.
  65  *
  66  *  O   The ident socket is able to but should not modify its
  67  *      'parent' user directly. Instead the ident socket class sets
  68  *      a completion flag and during the next call to OnCheckReady,
  69  *      the completion flag will be checked and any result copied to
  70  *      that user's class. This again ensures a single point of socket
  71  *      deletion for safer, neater code.
  72  *
  73  *  O   The code in the constructor of the ident socket is taken from
  74  *      BufferedSocket but majorly thinned down. It works for both
  75  *      IPv4 and IPv6.
  76  *
  77  *  O   In the event that the ident socket throws a ModuleException,
  78  *      nothing is done. This is counted as total and complete
  79  *      failure to create a connection.
  80  * --------------------------------------------------------------
  81  */
  82
  83 class IdentRequestSocket : public EventHandler
  84 {
  85  public:
  86         LocalUser *user;                        /* User we are attached to */
  87         std::string result;             /* Holds the ident string if done */
  88         time_t age;
  89         bool done;                      /* True if lookup is finished */
  90
  91         IdentRequestSocket(LocalUser* u) : user(u)
  92         {
  93                 age = ServerInstance->Time();
  94
  95                 SetFd(socket(user->server_sa.sa.sa_family, SOCK_STREAM, 0));
  96
  97                 if (GetFd() == -1)
  98                         throw ModuleException("Could not create socket");
  99
 100                 done = false;
 101
 102                 irc::sockets::sockaddrs bindaddr;
 103                 irc::sockets::sockaddrs connaddr;
 104
 105                 memcpy(&bindaddr, &user->server_sa, sizeof(bindaddr));
 106                 memcpy(&connaddr, &user->client_sa, sizeof(connaddr));
 107
 108                 if (connaddr.sa.sa_family == AF_INET6)
 109                 {
 110                         bindaddr.in6.sin6_port = 0;
 111                         connaddr.in6.sin6_port = htons(113);
 112                 }
 113                 else
 114                 {
 115                         bindaddr.in4.sin_port = 0;
 116                         connaddr.in4.sin_port = htons(113);
 117                 }
 118
 119                 /* Attempt to bind (ident requests must come from the ip the query is referring to */
 120                 if (SocketEngine::Bind(GetFd(), bindaddr) < 0)
 121                 {
 122                         this->Close();
 123                         throw ModuleException("failed to bind()");
 124                 }
 125
 126                 SocketEngine::NonBlocking(GetFd());
 127
 128                 /* Attempt connection (nonblocking) */
 129                 if (SocketEngine::Connect(this, &connaddr.sa, connaddr.sa_size()) == -1 && errno != EINPROGRESS)
 130                 {
 131                         this->Close();
 132                         throw ModuleException("connect() failed");
 133                 }
 134
 135                 /* Add fd to socket engine */
 136                 if (!SocketEngine::AddFd(this, FD_WANT_NO_READ | FD_WANT_POLL_WRITE))
 137                 {
 138                         this->Close();
 139                         throw ModuleException("out of fds");
 140                 }
 141         }
 142
 143         void OnConnected()
 144         {
 145                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnConnected()");
 146                 SocketEngine::ChangeEventMask(this, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
 147
 148                 char req[32];
 149
 150                 /* Build request in the form 'localport,remoteport\r\n' */
 151                 int req_size;
 152                 if (user->client_sa.sa.sa_family == AF_INET6)
 153                         req_size = snprintf(req, sizeof(req), "%d,%d\r\n",
 154                                 ntohs(user->client_sa.in6.sin6_port), ntohs(user->server_sa.in6.sin6_port));
 155                 else
 156                         req_size = snprintf(req, sizeof(req), "%d,%d\r\n",
 157                                 ntohs(user->client_sa.in4.sin_port), ntohs(user->server_sa.in4.sin_port));
 158
 159                 /* Send failed if we didnt write the whole ident request --
 160                  * might as well give up if this happens!
 161                  */
 162                 if (SocketEngine::Send(this, req, req_size, 0) < req_size)
 163                         done = true;
 164         }
 165
 166         void HandleEvent(EventType et, int errornum = 0)
 167         {
 168                 switch (et)
 169                 {
 170                         case EVENT_READ:
 171                                 /* fd readable event, received ident response */
 172                                 ReadResponse();
 173                         break;
 174                         case EVENT_WRITE:
 175                                 /* fd writeable event, successfully connected! */
 176                                 OnConnected();
 177                         break;
 178                         case EVENT_ERROR:
 179                                 /* fd error event, ohshi- */
 180                                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "EVENT_ERROR");
 181                                 /* We *must* Close() here immediately or we get a
 182                                  * huge storm of EVENT_ERROR events!
 183                                  */
 184                                 Close();
 185                                 done = true;
 186                         break;
 187                 }
 188         }
 189
 190         void Close()
 191         {
 192                 /* Remove ident socket from engine, and close it, but dont detatch it
 193                  * from its parent user class, or attempt to delete its memory.
 194                  */
 195                 if (GetFd() > -1)
 196                 {
 197                         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Close ident socket %d", GetFd());
 198                         SocketEngine::Close(this);
 199                 }
 200         }
 201
 202         bool HasResult()
 203         {
 204                 return done;
 205         }
 206
 207         void ReadResponse()
 208         {
 209                 /* We don't really need to buffer for incomplete replies here, since IDENT replies are
 210                  * extremely short - there is *no* sane reason it'd be in more than one packet
 211                  */
 212                 char ibuf[256];
 213                 int recvresult = SocketEngine::Recv(this, ibuf, sizeof(ibuf)-1, 0);
 214
 215                 /* Close (but don't delete from memory) our socket
 216                  * and flag as done since the ident lookup has finished
 217                  */
 218                 Close();
 219                 done = true;
 220
 221                 /* Cant possibly be a valid response shorter than 3 chars,
 222                  * because the shortest possible response would look like: '1,1'
 223                  */
 224                 if (recvresult < 3)
 225                         return;
 226
 227                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "ReadResponse()");
 228
 229                 /* Truncate at the first null character, but first make sure
 230                  * there is at least one null char (at the end of the buffer).
 231                  */
 232                 ibuf[recvresult] = '\0';
 233                 std::string buf(ibuf);
 234
 235                 /* <2 colons: invalid
 236                  *  2 colons: reply is an error
 237                  * >3 colons: there is a colon in the ident
 238                  */
 239                 if (std::count(buf.begin(), buf.end(), ':') != 3)
 240                         return;
 241
 242                 std::string::size_type lastcolon = buf.rfind(':');
 243
 244                 /* Truncate the ident at any characters we don't like, skip leading spaces */
 245                 for (std::string::const_iterator i = buf.begin()+lastcolon+1; i != buf.end(); ++i)
 246                 {
 247                         if (result.size() == ServerInstance->Config->Limits.IdentMax)
 248                                 /* Ident is getting too long */
 249                                 break;
 250
 251                         if (*i == ' ')
 252                                 continue;
 253
 254                         /* Add the next char to the result and see if it's still a valid ident,
 255                          * according to IsIdent(). If it isn't, then erase what we just added and
 256                          * we're done.
 257                          */
 258                         result += *i;
 259                         if (!ServerInstance->IsIdent(result))
 260                         {
 261                                 result.erase(result.end()-1);
 262                                 break;
 263                         }
 264                 }
 265         }
 266 };
 267
 268 class ModuleIdent : public Module
 269 {
 270         int RequestTimeout;
 271         SimpleExtItem<IdentRequestSocket> ext;
 272  public:
 273         ModuleIdent() : ext("ident_socket", this)
 274         {
 275         }
 276
 277         Version GetVersion() CXX11_OVERRIDE
 278         {
 279                 return Version("Provides support for RFC1413 ident lookups", VF_VENDOR);
 280         }
 281
 282         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 283         {
 284                 RequestTimeout = ServerInstance->Config->ConfValue("ident")->getInt("timeout", 5);
 285                 if (!RequestTimeout)
 286                         RequestTimeout = 5;
 287         }
 288
 289         void OnUserInit(LocalUser *user) CXX11_OVERRIDE
 290         {
 291                 ConfigTag* tag = user->MyClass->config;
 292                 if (!tag->getBool("useident", true))
 293                         return;
 294
 295                 user->WriteNotice("*** Looking up your ident...");
 296
 297                 try
 298                 {
 299                         IdentRequestSocket *isock = new IdentRequestSocket(IS_LOCAL(user));
 300                         ext.set(user, isock);
 301                 }
 302                 catch (ModuleException &e)
 303                 {
 304                         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Ident exception: " + e.GetReason());
 305                 }
 306         }
 307
 308         /* This triggers pretty regularly, we can use it in preference to
 309          * creating a Timer object and especially better than creating a
 310          * Timer per ident lookup!
 311          */
 312         ModResult OnCheckReady(LocalUser *user) CXX11_OVERRIDE
 313         {
 314                 /* Does user have an ident socket attached at all? */
 315                 IdentRequestSocket *isock = ext.get(user);
 316                 if (!isock)
 317                         return MOD_RES_PASSTHRU;
 318
 319                 time_t compare = isock->age;
 320                 compare += RequestTimeout;
 321
 322                 /* Check for timeout of the socket */
 323                 if (ServerInstance->Time() >= compare)
 324                 {
 325                         /* Ident timeout */
 326                         user->WriteNotice("*** Ident request timed out.");
 327                 }
 328                 else if (!isock->HasResult())
 329                 {
 330                         // time still good, no result yet... hold the registration
 331                         return MOD_RES_DENY;
 332                 }
 333
 334                 /* wooo, got a result (it will be good, or bad) */
 335                 if (isock->result.empty())
 336                 {
 337                         user->ident.insert(user->ident.begin(), 1, '~');
 338                         user->WriteNotice("*** Could not find your ident, using " + user->ident + " instead.");
 339                 }
 340                 else
 341                 {
 342                         user->ident = isock->result;
 343                         user->WriteNotice("*** Found your ident, '" + user->ident + "'");
 344                 }
 345
 346                 user->InvalidateCache();
 347                 isock->Close();
 348                 ext.unset(user);
 349                 return MOD_RES_PASSTHRU;
 350         }
 351
 352         ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
 353         {
 354                 if (myclass->config->getBool("requireident") && user->ident[0] == '~')
 355                         return MOD_RES_DENY;
 356                 return MOD_RES_PASSTHRU;
 357         }
 358
 359         void OnCleanup(int target_type, void *item) CXX11_OVERRIDE
 360         {
 361                 /* Module unloading, tidy up users */
 362                 if (target_type == TYPE_USER)
 363                 {
 364                         LocalUser* user = IS_LOCAL((User*) item);
 365                         if (user)
 366                                 OnUserDisconnect(user);
 367                 }
 368         }
 369
 370         void OnUserDisconnect(LocalUser *user) CXX11_OVERRIDE
 371         {
 372                 /* User disconnect (generic socket detatch event) */
 373                 IdentRequestSocket *isock = ext.get(user);
 374                 if (isock)
 375                 {
 376                         isock->Close();
 377                         ext.unset(user);
 378                 }
 379         }
 380 };
 381
 382 MODULE_INIT(ModuleIdent)