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