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