src/modules/m_ident.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 using namespace std;
  18
  19 #include <stdio.h>
  20 #include <string>
  21 #include "users.h"
  22 #include "channels.h"
  23 #include "modules.h"
  24 #include "inspircd.h"
  25
  26 extern userrec* fd_ref_table[MAX_DESCRIPTORS];
  27
  28 /* $ModDesc: Provides support for RFC 1413 ident lookups */
  29
  30 // Version 1.5.0.0 - Updated to use InspSocket, faster and neater.
  31
  32 class RFC1413 : public InspSocket
  33 {
  34  protected:
  35         Server* Srv;             // Server* class used for core communications
  36         sockaddr_in sock_us;     // our port number
  37         sockaddr_in sock_them;   // their port number
  38         socklen_t uslen;         // length of our port number
  39         socklen_t themlen;       // length of their port number
  40         char ident_request[128]; // buffer used to make up the request string
  41  public:
  42
  43         userrec* u;              // user record that the lookup is associated with
  44         int ufd;
  45
  46         RFC1413(userrec* user, int maxtime, Server* S) : InspSocket((char*)inet_ntoa(user->ip4), 113, false, maxtime), Srv(S), u(user), ufd(user->fd)
  47         {
  48                 Srv->Log(DEBUG,"Ident: associated.");
  49         }
  50
  51         virtual void OnTimeout()
  52         {
  53                 // When we timeout, the connection failed within the allowed timeframe,
  54                 // so we just display a notice, and tidy off the ident_data.
  55                 if (u && (fd_ref_table[ufd] == u))
  56                 {
  57                         u->Shrink("ident_data");
  58                         Srv->SendServ(u->fd,"NOTICE "+std::string(u->nick)+" :*** Could not find your ident, using "+std::string(u->ident)+" instead.");
  59                 }
  60         }
  61
  62         virtual bool OnDataReady()
  63         {
  64                 char* ibuf = this->Read();
  65                 if (ibuf)
  66                 {
  67                         char* savept;
  68                         char* section = strtok_r(ibuf,":",&savept);
  69                         while (section)
  70                         {
  71                                 if (strstr(section,"USERID"))
  72                                 {
  73                                         section = strtok_r(NULL,":",&savept);
  74                                         if (section)
  75                                         {
  76                                                 // ID type, usually UNIX or OTHER... we dont want it, so read the next token
  77                                                 section = strtok_r(NULL,":",&savept);
  78                                                 if (section)
  79                                                 {
  80                                                         while (*section == ' ') section++; // strip leading spaces
  81                                                         for (char* j = section; *j; j++)
  82                                                         if ((*j < 33) || (*j > 126))
  83                                                                 *j = '\0'; // truncate at invalid chars
  84                                                         if (*section)
  85                                                         {
  86                                                                 if (u && (fd_ref_table[ufd] == u))
  87                                                                 {
  88                                                                         strlcpy(u->ident,section,IDENTMAX);
  89                                                                         Srv->Log(DEBUG,"IDENT SET: "+std::string(u->ident));
  90                                                                         Srv->SendServ(u->fd,"NOTICE "+std::string(u->nick)+" :*** Found your ident: "+std::string(u->ident));
  91                                                                 }
  92                                                         }
  93                                                         return false;
  94                                                 }
  95                                         }
  96                                 }
  97                                 section = strtok_r(NULL,":",&savept);
  98                         }
  99                 }
 100                 return false;
 101         }
 102
 103         virtual void OnClose()
 104         {
 105                 // tidy up after ourselves when the connection is done.
 106                 // We receive this event straight after a timeout, too.
 107                 //
 108                 //
 109                 // OK, now listen up. The weird looking check here is
 110                 // REQUIRED. Don't try and optimize it away.
 111                 //
 112                 // When a socket is closed, it is not immediately removed
 113                 // from the socket list, there can be a short delay
 114                 // before it is culled from the list. This means that
 115                 // without this check, there is a chance that a user
 116                 // may not exist when we come to ::Shrink them, which
 117                 // results in a segfault. The value of "u" may not
 118                 // always be NULL at this point, so, what we do is
 119                 // check against the fd_ref_table, to see if (1) the user
 120                 // exists, and (2) its the SAME user, on the same file
 121                 // descriptor that they were when the lookup began.
 122                 //
 123                 // Fixes issue reported by webs, 7 Jun 2006
 124                 if (u && (fd_ref_table[ufd] == u))
 125                 {
 126                         u->Shrink("ident_data");
 127                 }
 128         }
 129
 130         virtual void OnError(InspSocketError e)
 131         {
 132                 if (u && (fd_ref_table[ufd] == u))
 133                 {
 134                         u->Shrink("ident_data");
 135                 }
 136         }
 137
 138         virtual bool OnConnected()
 139         {
 140                 if (u && (fd_ref_table[ufd] == u))
 141                 {
 142                         uslen = sizeof(sock_us);
 143                         themlen = sizeof(sock_them);
 144                         if ((getsockname(this->u->fd,(sockaddr*)&sock_us,&uslen) || getpeername(this->u->fd, (sockaddr*)&sock_them, &themlen)))
 145                         {
 146                                 Srv->Log(DEBUG,"Ident: failed to get socket names, bailing");
 147                                 return false;
 148                         }
 149                         else
 150                         {
 151                                 // send the request in the following format: theirsocket,oursocket
 152                                 snprintf(ident_request,127,"%d,%d\r\n",ntohs(sock_them.sin_port),ntohs(sock_us.sin_port));
 153                                 this->Write(ident_request);
 154                                 Srv->Log(DEBUG,"Sent ident request, waiting for reply");
 155                                 return true;
 156                         }
 157                 }
 158                 else
 159                 {
 160                         return true;
 161                 }
 162         }
 163 };
 164
 165 class ModuleIdent : public Module
 166 {
 167
 168         ConfigReader* Conf;
 169         Server* Srv;
 170         int IdentTimeout;
 171
 172  public:
 173         void ReadSettings()
 174         {
 175                 Conf = new ConfigReader;
 176                 IdentTimeout = Conf->ReadInteger("ident","timeout",0,true);
 177                 if (!IdentTimeout)
 178                         IdentTimeout = 1;
 179                 DELETE(Conf);
 180         }
 181
 182         ModuleIdent(Server* Me)
 183                 : Module::Module(Me)
 184         {
 185                 Srv = Me;
 186                 ReadSettings();
 187         }
 188
 189         void Implements(char* List)
 190         {
 191                 List[I_OnCleanup] = List[I_OnRehash] = List[I_OnUserRegister] = List[I_OnCheckReady] = List[I_OnUserDisconnect] = 1;
 192         }
 193
 194         virtual void OnRehash(const std::string &parameter)
 195         {
 196                 ReadSettings();
 197         }
 198
 199         virtual void OnUserRegister(userrec* user)
 200         {
 201                 /*
 202                  * when the new user connects, before they authenticate with USER/NICK/PASS, we do
 203                  * their ident lookup. We do this by instantiating an object of type RFC1413, which
 204                  * is derived from InspSocket, and inserting it into the socket engine using the
 205                  * Server::AddSocket() call.
 206                  */
 207                 Srv->SendServ(user->fd,"NOTICE "+std::string(user->nick)+" :*** Looking up your ident...");
 208                 RFC1413* ident = new RFC1413(user, IdentTimeout, Srv);
 209                 if (ident->GetState() != I_ERROR)
 210                 {
 211                         user->Extend("ident_data", (char*)ident);
 212                         Srv->AddSocket(ident);
 213                 }
 214                 else
 215                 {
 216                         Srv->SendServ(user->fd,"NOTICE "+std::string(user->nick)+" :*** Could not find your ident, using "+std::string(user->ident)+" instead.");
 217                         DELETE(ident);
 218                 }
 219         }
 220
 221         virtual bool OnCheckReady(userrec* user)
 222         {
 223                 /*
 224                  * The socket engine will clean up their ident request for us when it completes,
 225                  * either due to timeout or due to closing, so, we just hold them until they dont
 226                  * have an ident field any more.
 227                  */
 228                 RFC1413* ident;
 229                 return (!user->GetExt("ident_data", ident));
 230         }
 231
 232         virtual void OnCleanup(int target_type, void* item)
 233         {
 234                 if (target_type == TYPE_USER)
 235                 {
 236                         userrec* user = (userrec*)item;
 237                         RFC1413* ident;
 238                         if (user->GetExt("ident_data", ident))
 239                         {
 240                                 // FIX: If the user record is deleted, the socket wont be removed
 241                                 // immediately so there is chance of the socket trying to write to
 242                                 // a user which has now vanished! To prevent this, set ident::u
 243                                 // to NULL and check it so that we dont write users who have gone away.
 244                                 ident->u = NULL;
 245                                 Srv->RemoveSocket(ident);
 246                         }
 247                 }
 248         }
 249
 250         virtual void OnUserDisconnect(userrec* user)
 251         {
 252                 /*
 253                  * when the user quits tidy up any ident lookup they have pending to keep things tidy.
 254                  * When we call RemoveSocket, the abstractions tied into the system evnetually work their
 255                  * way to RFC1459::OnClose(), which shrinks off the ident_data for us, so we dont need
 256                  * to do it here. If we don't tidy this up, there may still be lingering idents for users
 257                  * who have quit, as class RFC1459 is only loosely bound to userrec* via a pair of pointers
 258                  * and this would leave at least one of the invalid ;)
 259                  */
 260                 RFC1413* ident;
 261                 if (user->GetExt("ident_data", ident))
 262                 {
 263                         ident->u = NULL;
 264                         Srv->RemoveSocket(ident);
 265                 }
 266         }
 267
 268         virtual ~ModuleIdent()
 269         {
 270         }
 271
 272         virtual Version GetVersion()
 273         {
 274                 return Version(1,5,0,0,VF_VENDOR);
 275         }
 276
 277 };
 278
 279 class ModuleIdentFactory : public ModuleFactory
 280 {
 281  public:
 282         ModuleIdentFactory()
 283         {
 284         }
 285
 286         ~ModuleIdentFactory()
 287         {
 288         }
 289
 290         virtual Module * CreateModule(Server* Me)
 291         {
 292                 return new ModuleIdent(Me);
 293         }
 294
 295 };
 296
 297
 298 extern "C" void * init_module( void )
 299 {
 300         return new ModuleIdentFactory;
 301 }
 302