src/modules/m_ident.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *          the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15
  16 /* $ModDesc: Provides support for RFC1413 ident lookups */
  17
  18 /* --------------------------------------------------------------
  19  * Note that this is the third incarnation of m_ident. The first
  20  * two attempts were pretty crashy, mainly due to the fact we tried
  21  * to use InspSocket/BufferedSocket to make them work. This class
  22  * is ok for more heavyweight tasks, it does a lot of things behind
  23  * the scenes that are not good for ident sockets and it has a huge
  24  * memory footprint!
  25  *
  26  * To fix all the issues that we had in the old ident modules (many
  27  * nasty race conditions that would cause segfaults etc) we have
  28  * rewritten this module to use a simplified socket object based
  29  * directly off EventHandler. As EventHandler only has low level
  30  * readability, writeability and error events tied directly to the
  31  * socket engine, this makes our lives easier as nothing happens to
  32  * our ident lookup class that is outside of this module, or out-
  33  * side of the control of the class. There are no timers, internal
  34  * events, or such, which will cause the socket to be deleted,
  35  * queued for deletion, etc. In fact, theres not even any queueing!
  36  *
  37  * Using this framework we have a much more stable module.
  38  *
  39  * A few things to note:
  40  *
  41  *   O  The only place that may *delete* an active or inactive
  42  *      ident socket is OnUserDisconnect in the module class.
  43  *      Because this is out of scope of the socket class there is
  44  *      no possibility that the socket may ever try to delete
  45  *      itself.
  46  *
  47  *   O  Closure of the ident socket with the Close() method will
  48  *      not cause removal of the socket from memory or detatchment
  49  *      from its 'parent' User class. It will only flag it as an
  50  *      inactive socket in the socket engine.
  51  *
  52  *   O  Timeouts are handled in OnCheckReaady at the same time as
  53  *      checking if the ident socket has a result. This is done
  54  *      by checking if the age the of the class (its instantiation
  55  *      time) plus the timeout value is greater than the current time.
  56  *
  57  *  O   The ident socket is able to but should not modify its
  58  *      'parent' user directly. Instead the ident socket class sets
  59  *      a completion flag and during the next call to OnCheckReady,
  60  *      the completion flag will be checked and any result copied to
  61  *      that user's class. This again ensures a single point of socket
  62  *      deletion for safer, neater code.
  63  *
  64  *  O   The code in the constructor of the ident socket is taken from
  65  *      BufferedSocket but majorly thinned down. It works for both
  66  *      IPv4 and IPv6.
  67  *
  68  *  O   In the event that the ident socket throws a ModuleException,
  69  *      nothing is done. This is counted as total and complete
  70  *      failure to create a connection.
  71  * --------------------------------------------------------------
  72  */
  73
  74 class IdentRequestSocket : public EventHandler
  75 {
  76  private:
  77         User *user;                     /* User we are attached to */
  78         bool done;                      /* True if lookup is finished */
  79         std::string result;             /* Holds the ident string if done */
  80  public:
  81         time_t age;
  82
  83         IdentRequestSocket(User* u) : user(u), result(u->ident)
  84         {
  85                 age = ServerInstance->Time();
  86                 socklen_t size = 0;
  87
  88                 SetFd(socket(user->server_sa.sa.sa_family, SOCK_STREAM, 0));
  89
  90                 if (GetFd() == -1)
  91                         throw ModuleException("Could not create socket");
  92
  93                 done = false;
  94
  95                 irc::sockets::sockaddrs bindaddr;
  96                 irc::sockets::sockaddrs connaddr;
  97
  98                 memcpy(&bindaddr, &user->server_sa, sizeof(bindaddr));
  99                 memcpy(&connaddr, &user->client_sa, sizeof(connaddr));
 100
 101                 if (connaddr.sa.sa_family == AF_INET6)
 102                 {
 103                         bindaddr.in6.sin6_port = 0;
 104                         connaddr.in6.sin6_port = htons(113);
 105                 }
 106                 else
 107                 {
 108                         bindaddr.in4.sin_port = 0;
 109                         connaddr.in4.sin_port = htons(113);
 110                 }
 111
 112                 /* Attempt to bind (ident requests must come from the ip the query is referring to */
 113                 if (ServerInstance->SE->Bind(GetFd(), &bindaddr.sa, size) < 0)
 114                 {
 115                         this->Close();
 116                         throw ModuleException("failed to bind()");
 117                 }
 118
 119                 ServerInstance->SE->NonBlocking(GetFd());
 120
 121                 /* Attempt connection (nonblocking) */
 122                 if (ServerInstance->SE->Connect(this, &connaddr.sa, size) == -1 && errno != EINPROGRESS)
 123                 {
 124                         this->Close();
 125                         throw ModuleException("connect() failed");
 126                 }
 127
 128                 /* Add fd to socket engine */
 129                 if (!ServerInstance->SE->AddFd(this, FD_WANT_NO_READ | FD_WANT_POLL_WRITE))
 130                 {
 131                         this->Close();
 132                         throw ModuleException("out of fds");
 133                 }
 134         }
 135
 136         virtual void OnConnected()
 137         {
 138                 ServerInstance->Logs->Log("m_ident",DEBUG,"OnConnected()");
 139                 ServerInstance->SE->ChangeEventMask(this, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
 140
 141                 char req[32];
 142
 143                 /* Build request in the form 'localport,remoteport\r\n' */
 144                 int req_size;
 145                 if (user->client_sa.sa.sa_family == AF_INET6)
 146                         req_size = snprintf(req, sizeof(req), "%d,%d\r\n",
 147                                 ntohs(user->client_sa.in6.sin6_port), ntohs(user->server_sa.in6.sin6_port));
 148                 else
 149                         req_size = snprintf(req, sizeof(req), "%d,%d\r\n",
 150                                 ntohs(user->client_sa.in4.sin_port), ntohs(user->server_sa.in4.sin_port));
 151
 152                 /* Send failed if we didnt write the whole ident request --
 153                  * might as well give up if this happens!
 154                  */
 155                 if (ServerInstance->SE->Send(this, req, req_size, 0) < req_size)
 156                         done = true;
 157         }
 158
 159         virtual void HandleEvent(EventType et, int errornum = 0)
 160         {
 161                 switch (et)
 162                 {
 163                         case EVENT_READ:
 164                                 /* fd readable event, received ident response */
 165                                 ReadResponse();
 166                         break;
 167                         case EVENT_WRITE:
 168                                 /* fd writeable event, successfully connected! */
 169                                 OnConnected();
 170                         break;
 171                         case EVENT_ERROR:
 172                                 /* fd error event, ohshi- */
 173                                 ServerInstance->Logs->Log("m_ident",DEBUG,"EVENT_ERROR");
 174                                 /* We *must* Close() here immediately or we get a
 175                                  * huge storm of EVENT_ERROR events!
 176                                  */
 177                                 Close();
 178                                 done = true;
 179                         break;
 180                 }
 181         }
 182
 183         void Close()
 184         {
 185                 /* Remove ident socket from engine, and close it, but dont detatch it
 186                  * from its parent user class, or attempt to delete its memory.
 187                  */
 188                 if (GetFd() > -1)
 189                 {
 190                         ServerInstance->Logs->Log("m_ident",DEBUG,"Close ident socket %d", GetFd());
 191                         ServerInstance->SE->DelFd(this);
 192                         ServerInstance->SE->Close(GetFd());
 193                         ServerInstance->SE->Shutdown(GetFd(), SHUT_WR);
 194                         this->SetFd(-1);
 195                 }
 196         }
 197
 198         bool HasResult()
 199         {
 200                 return done;
 201         }
 202
 203         /* Note: if the lookup succeeded, will contain 'ident', otherwise
 204          * will contain '~ident'. Use *GetResult() to determine lookup success.
 205          */
 206         const char* GetResult()
 207         {
 208                 return result.c_str();
 209         }
 210
 211         void ReadResponse()
 212         {
 213                 /* We don't really need to buffer for incomplete replies here, since IDENT replies are
 214                  * extremely short - there is *no* sane reason it'd be in more than one packet
 215                  */
 216                 char ibuf[MAXBUF];
 217                 int recvresult = ServerInstance->SE->Recv(this, ibuf, MAXBUF-1, 0);
 218
 219                 /* Cant possibly be a valid response shorter than 3 chars,
 220                  * because the shortest possible response would look like: '1,1'
 221                  */
 222                 if (recvresult < 3)
 223                 {
 224                         Close();
 225                         done = true;
 226                         return;
 227                 }
 228
 229                 ServerInstance->Logs->Log("m_ident",DEBUG,"ReadResponse()");
 230
 231                 irc::sepstream sep(ibuf, ':');
 232                 std::string token;
 233                 for (int i = 0; sep.GetToken(token); i++)
 234                 {
 235                         /* We only really care about the 4th portion */
 236                         if (i < 3)
 237                                 continue;
 238
 239                         std::string ident;
 240
 241                         /* Truncate the ident at any characters we don't like, skip leading spaces */
 242                         size_t k = 0;
 243                         for (const char *j = token.c_str(); *j && (k < ServerInstance->Config->Limits.IdentMax + 1); j++)
 244                         {
 245                                 if (*j == ' ')
 246                                         continue;
 247
 248                                 /* Rules taken from InspIRCd::IsIdent */
 249                                 if (((*j >= 'A') && (*j <= '}')) || ((*j >= '0') && (*j <= '9')) || (*j == '-') || (*j == '.'))
 250                                 {
 251                                         ident += *j;
 252                                         continue;
 253                                 }
 254
 255                                 break;
 256                         }
 257
 258                         /* Re-check with IsIdent, in case that changes and this doesn't (paranoia!) */
 259                         if (!ident.empty() && ServerInstance->IsIdent(ident.c_str()))
 260                         {
 261                                 result = ident;
 262                         }
 263
 264                         break;
 265                 }
 266
 267                 /* Close (but dont delete from memory) our socket
 268                  * and flag as done
 269                  */
 270                 Close();
 271                 done = true;
 272                 return;
 273         }
 274 };
 275
 276 class ModuleIdent : public Module
 277 {
 278         int RequestTimeout;
 279         ConfigReader *Conf;
 280         SimpleExtItem<IdentRequestSocket> ext;
 281  public:
 282         ModuleIdent() : ext("ident_socket", this)
 283         {
 284                 Conf = new ConfigReader;
 285                 OnRehash(NULL);
 286                 Implementation eventlist[] = { I_OnRehash, I_OnUserRegister, I_OnCheckReady, I_OnCleanup, I_OnUserDisconnect };
 287                 ServerInstance->Modules->Attach(eventlist, this, 5);
 288         }
 289
 290         ~ModuleIdent()
 291         {
 292                 delete Conf;
 293         }
 294
 295         virtual Version GetVersion()
 296         {
 297                 return Version("Provides support for RFC1413 ident lookups", VF_VENDOR, API_VERSION);
 298         }
 299
 300         virtual void OnRehash(User *user)
 301         {
 302                 delete Conf;
 303                 Conf = new ConfigReader;
 304
 305                 RequestTimeout = Conf->ReadInteger("ident", "timeout", 0, true);
 306                 if (!RequestTimeout)
 307                         RequestTimeout = 5;
 308         }
 309
 310         virtual ModResult OnUserRegister(User *user)
 311         {
 312                 for (int j = 0; j < Conf->Enumerate("connect"); j++)
 313                 {
 314                         std::string hostn = Conf->ReadValue("connect","allow",j);
 315                         /* XXX: Fixme: does not respect port, limit, etc */
 316                         if ((InspIRCd::MatchCIDR(user->GetIPString(),hostn, ascii_case_insensitive_map)) || (InspIRCd::Match(user->host,hostn, ascii_case_insensitive_map)))
 317                         {
 318                                 bool useident = Conf->ReadFlag("connect", "useident", "yes", j);
 319
 320                                 if (!useident)
 321                                         return MOD_RES_PASSTHRU;
 322                         }
 323                 }
 324
 325                 /* User::ident is currently the username field from USER; with m_ident loaded, that
 326                  * should be preceded by a ~. The field is actually IdentMax+2 characters wide. */
 327                 if (user->ident.length() > ServerInstance->Config->Limits.IdentMax + 1)
 328                         user->ident.assign(user->ident, 0, ServerInstance->Config->Limits.IdentMax);
 329                 user->ident.insert(0, "~");
 330
 331                 user->WriteServ("NOTICE Auth :*** Looking up your ident...");
 332
 333                 try
 334                 {
 335                         IdentRequestSocket *isock = new IdentRequestSocket(user);
 336                         ext.set(user, isock);
 337                 }
 338                 catch (ModuleException &e)
 339                 {
 340                         ServerInstance->Logs->Log("m_ident",DEBUG,"Ident exception: %s", e.GetReason());
 341                 }
 342
 343                 return MOD_RES_PASSTHRU;
 344         }
 345
 346         /* This triggers pretty regularly, we can use it in preference to
 347          * creating a Timer object and especially better than creating a
 348          * Timer per ident lookup!
 349          */
 350         virtual ModResult OnCheckReady(User *user)
 351         {
 352                 /* Does user have an ident socket attached at all? */
 353                 IdentRequestSocket *isock = ext.get(user);
 354                 if (!isock)
 355                 {
 356                         ServerInstance->Logs->Log("m_ident",DEBUG, "No ident socket :(");
 357                         return MOD_RES_PASSTHRU;
 358                 }
 359
 360                 ServerInstance->Logs->Log("m_ident",DEBUG, "Has ident_socket");
 361
 362                 time_t compare = isock->age;
 363                 compare += RequestTimeout;
 364
 365                 /* Check for timeout of the socket */
 366                 if (ServerInstance->Time() >= compare)
 367                 {
 368                         /* Ident timeout */
 369                         user->WriteServ("NOTICE Auth :*** Ident request timed out.");
 370                         ServerInstance->Logs->Log("m_ident",DEBUG, "Timeout");
 371                         /* The user isnt actually disconnecting,
 372                          * we call this to clean up the user
 373                          */
 374                         OnUserDisconnect(user);
 375                         return MOD_RES_PASSTHRU;
 376                 }
 377
 378                 /* Got a result yet? */
 379                 if (!isock->HasResult())
 380                 {
 381                         ServerInstance->Logs->Log("m_ident",DEBUG, "No result yet");
 382                         return MOD_RES_DENY;
 383                 }
 384
 385                 ServerInstance->Logs->Log("m_ident",DEBUG, "Yay, result!");
 386
 387                 /* wooo, got a result (it will be good, or bad) */
 388                 if (*(isock->GetResult()) != '~')
 389                         user->WriteServ("NOTICE Auth :*** Found your ident, '%s'", isock->GetResult());
 390                 else
 391                         user->WriteServ("NOTICE Auth :*** Could not find your ident, using %s instead.", isock->GetResult());
 392
 393                 /* Copy the ident string to the user */
 394                 user->ChangeIdent(isock->GetResult());
 395
 396                 /* The user isnt actually disconnecting, we call this to clean up the user */
 397                 OnUserDisconnect(user);
 398                 return MOD_RES_PASSTHRU;
 399         }
 400
 401         virtual void OnCleanup(int target_type, void *item)
 402         {
 403                 /* Module unloading, tidy up users */
 404                 if (target_type == TYPE_USER)
 405                         OnUserDisconnect((User*)item);
 406         }
 407
 408         virtual void OnUserDisconnect(User *user)
 409         {
 410                 /* User disconnect (generic socket detatch event) */
 411                 IdentRequestSocket *isock = ext.get(user);
 412                 if (isock)
 413                 {
 414                         isock->Close();
 415                         ext.unset(user);
 416                 }
 417         }
 418 };
 419
 420 MODULE_INIT(ModuleIdent)
 421