]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_ident.cpp
Convert a bunch of time-related config options to getDuration.
[user/henk/code/inspircd.git] / src / modules / m_ident.cpp
index e5c8940ec29041fe1b4861f18689670c927e9b0f..806c70ad2410b86c4ece7c09850f50abab959b3d 100644 (file)
@@ -1,19 +1,28 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007, 2009 John Brooks <john.brooks@dereferenced.net>
+ *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  *
- * This program is free but copyrighted software; see
- *         the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "inspircd.h"
 
-/* $ModDesc: Provides support for RFC1413 ident lookups */
+#include "inspircd.h"
 
 /* --------------------------------------------------------------
  * Note that this is the third incarnation of m_ident. The first
 
 class IdentRequestSocket : public EventHandler
 {
- private:
-       User *user;                     /* User we are attached to */
-       InspIRCd* ServerInstance;       /* Server instance */
-       bool done;                      /* True if lookup is finished */
-       std::string result;             /* Holds the ident string if done */
  public:
+       LocalUser *user;                        /* User we are attached to */
+       std::string result;             /* Holds the ident string if done */
        time_t age;
+       bool done;                      /* True if lookup is finished */
 
-       IdentRequestSocket(InspIRCd *Server, User* u) : user(u), ServerInstance(Server), result(u->ident)
+       IdentRequestSocket(LocalUser* u) : user(u)
        {
                age = ServerInstance->Time();
-               socklen_t size = 0;
 
                SetFd(socket(user->server_sa.sa.sa_family, SOCK_STREAM, 0));
 
@@ -111,37 +117,32 @@ class IdentRequestSocket : public EventHandler
                }
 
                /* Attempt to bind (ident requests must come from the ip the query is referring to */
-               if (ServerInstance->SE->Bind(GetFd(), &bindaddr.sa, size) < 0)
+               if (SocketEngine::Bind(GetFd(), bindaddr) < 0)
                {
                        this->Close();
                        throw ModuleException("failed to bind()");
                }
 
-               ServerInstance->SE->NonBlocking(GetFd());
+               SocketEngine::NonBlocking(GetFd());
 
                /* Attempt connection (nonblocking) */
-               if (ServerInstance->SE->Connect(this, &connaddr.sa, size) == -1 && errno != EINPROGRESS)
+               if (SocketEngine::Connect(this, &connaddr.sa, connaddr.sa_size()) == -1 && errno != EINPROGRESS)
                {
                        this->Close();
                        throw ModuleException("connect() failed");
                }
 
                /* Add fd to socket engine */
-               if (!ServerInstance->SE->AddFd(this))
+               if (!SocketEngine::AddFd(this, FD_WANT_NO_READ | FD_WANT_POLL_WRITE))
                {
                        this->Close();
                        throw ModuleException("out of fds");
                }
-
-               /* Important: We set WantWrite immediately after connect()
-                * because a successful connection will trigger a writability event
-                */
-               ServerInstance->SE->WantWrite(this);
        }
 
-       virtual void OnConnected()
+       void OnEventHandlerWrite() CXX11_OVERRIDE
        {
-               ServerInstance->Logs->Log("m_ident",DEBUG,"OnConnected()");
+               SocketEngine::ChangeEventMask(this, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
 
                char req[32];
 
@@ -157,34 +158,10 @@ class IdentRequestSocket : public EventHandler
                /* Send failed if we didnt write the whole ident request --
                 * might as well give up if this happens!
                 */
-               if (ServerInstance->SE->Send(this, req, req_size, 0) < req_size)
+               if (SocketEngine::Send(this, req, req_size, 0) < req_size)
                        done = true;
        }
 
-       virtual void HandleEvent(EventType et, int errornum = 0)
-       {
-               switch (et)
-               {
-                       case EVENT_READ:
-                               /* fd readable event, received ident response */
-                               ReadResponse();
-                       break;
-                       case EVENT_WRITE:
-                               /* fd writeable event, successfully connected! */
-                               OnConnected();
-                       break;
-                       case EVENT_ERROR:
-                               /* fd error event, ohshi- */
-                               ServerInstance->Logs->Log("m_ident",DEBUG,"EVENT_ERROR");
-                               /* We *must* Close() here immediately or we get a
-                                * huge storm of EVENT_ERROR events!
-                                */
-                               Close();
-                               done = true;
-                       break;
-               }
-       }
-
        void Close()
        {
                /* Remove ident socket from engine, and close it, but dont detatch it
@@ -192,11 +169,8 @@ class IdentRequestSocket : public EventHandler
                 */
                if (GetFd() > -1)
                {
-                       ServerInstance->Logs->Log("m_ident",DEBUG,"Close ident socket %d", GetFd());
-                       ServerInstance->SE->DelFd(this);
-                       ServerInstance->SE->Close(GetFd());
-                       ServerInstance->SE->Shutdown(GetFd(), SHUT_WR);
-                       this->SetFd(-1);
+                       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Close ident socket %d", GetFd());
+                       SocketEngine::Close(this);
                }
        }
 
@@ -205,165 +179,136 @@ class IdentRequestSocket : public EventHandler
                return done;
        }
 
-       /* Note: if the lookup succeeded, will contain 'ident', otherwise
-        * will contain '~ident'. Use *GetResult() to determine lookup success.
-        */
-       const char* GetResult()
-       {
-               return result.c_str();
-       }
-
-       void ReadResponse()
+       void OnEventHandlerRead() CXX11_OVERRIDE
        {
                /* We don't really need to buffer for incomplete replies here, since IDENT replies are
                 * extremely short - there is *no* sane reason it'd be in more than one packet
                 */
-               char ibuf[MAXBUF];
-               int recvresult = ServerInstance->SE->Recv(this, ibuf, MAXBUF-1, 0);
+               char ibuf[256];
+               int recvresult = SocketEngine::Recv(this, ibuf, sizeof(ibuf)-1, 0);
+
+               /* Close (but don't delete from memory) our socket
+                * and flag as done since the ident lookup has finished
+                */
+               Close();
+               done = true;
 
                /* Cant possibly be a valid response shorter than 3 chars,
                 * because the shortest possible response would look like: '1,1'
                 */
                if (recvresult < 3)
-               {
-                       Close();
-                       done = true;
                        return;
-               }
 
-               ServerInstance->Logs->Log("m_ident",DEBUG,"ReadResponse()");
+               ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "ReadResponse()");
 
-               irc::sepstream sep(ibuf, ':');
-               std::string token;
-               for (int i = 0; sep.GetToken(token); i++)
-               {
-                       /* We only really care about the 4th portion */
-                       if (i < 3)
-                               continue;
-
-                       std::string ident;
+               /* Truncate at the first null character, but first make sure
+                * there is at least one null char (at the end of the buffer).
+                */
+               ibuf[recvresult] = '\0';
+               std::string buf(ibuf);
 
-                       /* Truncate the ident at any characters we don't like, skip leading spaces */
-                       size_t k = 0;
-                       for (const char *j = token.c_str(); *j && (k < ServerInstance->Config->Limits.IdentMax + 1); j++)
-                       {
-                               if (*j == ' ')
-                                       continue;
+               /* <2 colons: invalid
+                *  2 colons: reply is an error
+                * >3 colons: there is a colon in the ident
+                */
+               if (std::count(buf.begin(), buf.end(), ':') != 3)
+                       return;
 
-                               /* Rules taken from InspIRCd::IsIdent */
-                               if (((*j >= 'A') && (*j <= '}')) || ((*j >= '0') && (*j <= '9')) || (*j == '-') || (*j == '.'))
-                               {
-                                       ident += *j;
-                                       continue;
-                               }
+               std::string::size_type lastcolon = buf.rfind(':');
 
+               /* Truncate the ident at any characters we don't like, skip leading spaces */
+               for (std::string::const_iterator i = buf.begin()+lastcolon+1; i != buf.end(); ++i)
+               {
+                       if (result.size() == ServerInstance->Config->Limits.IdentMax)
+                               /* Ident is getting too long */
                                break;
-                       }
 
-                       /* Re-check with IsIdent, in case that changes and this doesn't (paranoia!) */
-                       if (!ident.empty() && ServerInstance->IsIdent(ident.c_str()))
+                       if (*i == ' ')
+                               continue;
+
+                       /* Add the next char to the result and see if it's still a valid ident,
+                        * according to IsIdent(). If it isn't, then erase what we just added and
+                        * we're done.
+                        */
+                       result += *i;
+                       if (!ServerInstance->IsIdent(result))
                        {
-                               result = ident;
+                               result.erase(result.end()-1);
+                               break;
                        }
-
-                       break;
                }
+       }
 
-               /* Close (but dont delete from memory) our socket
-                * and flag as done
-                */
+       void OnEventHandlerError(int errornum) CXX11_OVERRIDE
+       {
                Close();
                done = true;
-               return;
+       }
+
+       CullResult cull() CXX11_OVERRIDE
+       {
+               Close();
+               return EventHandler::cull();
        }
 };
 
 class ModuleIdent : public Module
 {
        int RequestTimeout;
-       ConfigReader *Conf;
-       SimpleExtItem<IdentRequestSocket> ext;
+       bool NoLookupPrefix;
+       SimpleExtItem<IdentRequestSocket, stdalgo::culldeleter> ext;
  public:
-       ModuleIdent(InspIRCd *Me) : Module(Me), ext("ident_socket", this)
-       {
-               Conf = new ConfigReader(ServerInstance);
-               OnRehash(NULL);
-               Implementation eventlist[] = { I_OnRehash, I_OnUserRegister, I_OnCheckReady, I_OnCleanup, I_OnUserDisconnect };
-               ServerInstance->Modules->Attach(eventlist, this, 5);
-       }
-
-       ~ModuleIdent()
+       ModuleIdent()
+               : ext("ident_socket", ExtensionItem::EXT_USER, this)
        {
-               delete Conf;
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("$Id$", VF_VENDOR, API_VERSION);
+               return Version("Provides support for RFC1413 ident lookups", VF_VENDOR);
        }
 
-       virtual void OnRehash(User *user)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               delete Conf;
-               Conf = new ConfigReader(ServerInstance);
-
-               RequestTimeout = Conf->ReadInteger("ident", "timeout", 0, true);
-               if (!RequestTimeout)
-                       RequestTimeout = 5;
+               ConfigTag* tag = ServerInstance->Config->ConfValue("ident");
+               RequestTimeout = tag->getDuration("timeout", 5, 1);
+               NoLookupPrefix = tag->getBool("nolookupprefix", false);
        }
 
-       virtual ModResult OnUserRegister(User *user)
+       void OnUserInit(LocalUser *user) CXX11_OVERRIDE
        {
-               for (int j = 0; j < Conf->Enumerate("connect"); j++)
-               {
-                       std::string hostn = Conf->ReadValue("connect","allow",j);
-                       /* XXX: Fixme: does not respect port, limit, etc */
-                       if ((InspIRCd::MatchCIDR(user->GetIPString(),hostn, ascii_case_insensitive_map)) || (InspIRCd::Match(user->host,hostn, ascii_case_insensitive_map)))
-                       {
-                               bool useident = Conf->ReadFlag("connect", "useident", "yes", j);
-
-                               if (!useident)
-                                       return MOD_RES_PASSTHRU;
-                       }
-               }
-
-               /* User::ident is currently the username field from USER; with m_ident loaded, that
-                * should be preceded by a ~. The field is actually IdentMax+2 characters wide. */
-               if (user->ident.length() > ServerInstance->Config->Limits.IdentMax + 1)
-                       user->ident.assign(user->ident, 0, ServerInstance->Config->Limits.IdentMax);
-               user->ident.insert(0, "~");
+               ConfigTag* tag = user->MyClass->config;
+               if (!tag->getBool("useident", true))
+                       return;
 
-               user->WriteServ("NOTICE Auth :*** Looking up your ident...");
+               user->WriteNotice("*** Looking up your ident...");
 
                try
                {
-                       IdentRequestSocket *isock = new IdentRequestSocket(ServerInstance, user);
+                       IdentRequestSocket *isock = new IdentRequestSocket(user);
                        ext.set(user, isock);
                }
                catch (ModuleException &e)
                {
-                       ServerInstance->Logs->Log("m_ident",DEBUG,"Ident exception: %s", e.GetReason());
+                       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Ident exception: " + e.GetReason());
                }
-
-               return MOD_RES_PASSTHRU;
        }
 
        /* This triggers pretty regularly, we can use it in preference to
         * creating a Timer object and especially better than creating a
         * Timer per ident lookup!
         */
-       virtual ModResult OnCheckReady(User *user)
+       ModResult OnCheckReady(LocalUser *user) CXX11_OVERRIDE
        {
                /* Does user have an ident socket attached at all? */
                IdentRequestSocket *isock = ext.get(user);
                if (!isock)
                {
-                       ServerInstance->Logs->Log("m_ident",DEBUG, "No ident socket :(");
+                       if ((NoLookupPrefix) && (user->ident[0] != '~'))
+                               user->ident.insert(user->ident.begin(), 1, '~');
                        return MOD_RES_PASSTHRU;
                }
 
-               ServerInstance->Logs->Log("m_ident",DEBUG, "Has ident_socket");
-
                time_t compare = isock->age;
                compare += RequestTimeout;
 
@@ -371,56 +316,38 @@ class ModuleIdent : public Module
                if (ServerInstance->Time() >= compare)
                {
                        /* Ident timeout */
-                       user->WriteServ("NOTICE Auth :*** Ident request timed out.");
-                       ServerInstance->Logs->Log("m_ident",DEBUG, "Timeout");
-                       /* The user isnt actually disconnecting,
-                        * we call this to clean up the user
-                        */
-                       OnUserDisconnect(user);
-                       return MOD_RES_PASSTHRU;
+                       user->WriteNotice("*** Ident request timed out.");
                }
-
-               /* Got a result yet? */
-               if (!isock->HasResult())
+               else if (!isock->HasResult())
                {
-                       ServerInstance->Logs->Log("m_ident",DEBUG, "No result yet");
+                       // time still good, no result yet... hold the registration
                        return MOD_RES_DENY;
                }
 
-               ServerInstance->Logs->Log("m_ident",DEBUG, "Yay, result!");
-
                /* wooo, got a result (it will be good, or bad) */
-               if (*(isock->GetResult()) != '~')
-                       user->WriteServ("NOTICE Auth :*** Found your ident, '%s'", isock->GetResult());
+               if (isock->result.empty())
+               {
+                       user->ident.insert(user->ident.begin(), 1, '~');
+                       user->WriteNotice("*** Could not find your ident, using " + user->ident + " instead.");
+               }
                else
-                       user->WriteServ("NOTICE Auth :*** Could not find your ident, using %s instead.", isock->GetResult());
-
-               /* Copy the ident string to the user */
-               user->ChangeIdent(isock->GetResult());
+               {
+                       user->ident = isock->result;
+                       user->WriteNotice("*** Found your ident, '" + user->ident + "'");
+               }
 
-               /* The user isnt actually disconnecting, we call this to clean up the user */
-               OnUserDisconnect(user);
+               user->InvalidateCache();
+               isock->Close();
+               ext.unset(user);
                return MOD_RES_PASSTHRU;
        }
 
-       virtual void OnCleanup(int target_type, void *item)
+       ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
        {
-               /* Module unloading, tidy up users */
-               if (target_type == TYPE_USER)
-                       OnUserDisconnect((User*)item);
-       }
-
-       virtual void OnUserDisconnect(User *user)
-       {
-               /* User disconnect (generic socket detatch event) */
-               IdentRequestSocket *isock = ext.get(user);
-               if (isock)
-               {
-                       isock->Close();
-                       ext.unset(user);
-               }
+               if (myclass->config->getBool("requireident") && user->ident[0] == '~')
+                       return MOD_RES_DENY;
+               return MOD_RES_PASSTHRU;
        }
 };
 
 MODULE_INIT(ModuleIdent)
-