* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
+ *
* This program is free but copyrighted software; see
- * the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
-using namespace std;
-
-#include <stdio.h>
-#include <string>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
#include "inspircd.h"
-/* $ModDesc: Provides support for RFC 1413 ident lookups */
+/* $ModDesc: Provides support for RFC1413 ident lookups */
-// Version 1.5.0.0 - Updated to use InspSocket, faster and neater.
+/* --------------------------------------------------------------
+ * Note that this is the third incarnation of m_ident. The first
+ * two attempts were pretty crashy, mainly due to the fact we tried
+ * to use InspSocket/BufferedSocket to make them work. This class
+ * is ok for more heavyweight tasks, it does a lot of things behind
+ * the scenes that are not good for ident sockets and it has a huge
+ * memory footprint!
+ *
+ * To fix all the issues that we had in the old ident modules (many
+ * nasty race conditions that would cause segfaults etc) we have
+ * rewritten this module to use a simplified socket object based
+ * directly off EventHandler. As EventHandler only has low level
+ * readability, writeability and error events tied directly to the
+ * socket engine, this makes our lives easier as nothing happens to
+ * our ident lookup class that is outside of this module, or out-
+ * side of the control of the class. There are no timers, internal
+ * events, or such, which will cause the socket to be deleted,
+ * queued for deletion, etc. In fact, theres not even any queueing!
+ *
+ * Using this framework we have a much more stable module.
+ *
+ * A few things to note:
+ *
+ * O The only place that may *delete* an active or inactive
+ * ident socket is OnUserDisconnect in the module class.
+ * Because this is out of scope of the socket class there is
+ * no possibility that the socket may ever try to delete
+ * itself.
+ *
+ * O Closure of the ident socket with the Close() method will
+ * not cause removal of the socket from memory or detatchment
+ * from its 'parent' User class. It will only flag it as an
+ * inactive socket in the socket engine.
+ *
+ * O Timeouts are handled in OnCheckReaady at the same time as
+ * checking if the ident socket has a result. This is done
+ * by checking if the age the of the class (its instantiation
+ * time) plus the timeout value is greater than the current time.
+ *
+ * O The ident socket is able to but should not modify its
+ * 'parent' user directly. Instead the ident socket class sets
+ * a completion flag and during the next call to OnCheckReady,
+ * the completion flag will be checked and any result copied to
+ * that user's class. This again ensures a single point of socket
+ * deletion for safer, neater code.
+ *
+ * O The code in the constructor of the ident socket is taken from
+ * BufferedSocket but majorly thinned down. It works for both
+ * IPv4 and IPv6.
+ *
+ * O In the event that the ident socket throws a ModuleException,
+ * nothing is done. This is counted as total and complete
+ * failure to create a connection.
+ * --------------------------------------------------------------
+ */
-class RFC1413 : public InspSocket
+class IdentRequestSocket : public EventHandler
{
- protected:
- // Server* class used for core communications
- insp_sockaddr sock_us; // our port number
- insp_sockaddr sock_them; // their port number
- socklen_t uslen; // length of our port number
- socklen_t themlen; // length of their port number
- char ident_request[128]; // buffer used to make up the request string
+ private:
+ User *user; /* User we are attached to */
+ bool done; /* True if lookup is finished */
+ std::string result; /* Holds the ident string if done */
public:
+ time_t age;
+
+ IdentRequestSocket(User* u) : user(u), result(u->ident)
+ {
+ age = ServerInstance->Time();
+ socklen_t size = 0;
+
+ SetFd(socket(user->server_sa.sa.sa_family, SOCK_STREAM, 0));
+
+ if (GetFd() == -1)
+ throw ModuleException("Could not create socket");
+
+ done = false;
+
+ irc::sockets::sockaddrs bindaddr;
+ irc::sockets::sockaddrs connaddr;
+
+ memcpy(&bindaddr, &user->server_sa, sizeof(bindaddr));
+ memcpy(&connaddr, &user->client_sa, sizeof(connaddr));
+
+ if (connaddr.sa.sa_family == AF_INET6)
+ {
+ bindaddr.in6.sin6_port = 0;
+ connaddr.in6.sin6_port = htons(113);
+ }
+ else
+ {
+ bindaddr.in4.sin_port = 0;
+ connaddr.in4.sin_port = htons(113);
+ }
+
+ /* Attempt to bind (ident requests must come from the ip the query is referring to */
+ if (ServerInstance->SE->Bind(GetFd(), &bindaddr.sa, size) < 0)
+ {
+ this->Close();
+ throw ModuleException("failed to bind()");
+ }
+
+ ServerInstance->SE->NonBlocking(GetFd());
+
+ /* Attempt connection (nonblocking) */
+ if (ServerInstance->SE->Connect(this, &connaddr.sa, size) == -1 && errno != EINPROGRESS)
+ {
+ this->Close();
+ throw ModuleException("connect() failed");
+ }
- userrec* u; // user record that the lookup is associated with
- int ufd;
+ /* Add fd to socket engine */
+ if (!ServerInstance->SE->AddFd(this, FD_WANT_NO_READ | FD_WANT_POLL_WRITE))
+ {
+ this->Close();
+ throw ModuleException("out of fds");
+ }
+ }
- RFC1413(InspIRCd* SI, userrec* user, int maxtime) : InspSocket(SI, user->GetIPString(), 113, false, maxtime), u(user)
+ virtual void OnConnected()
{
- ufd = user->GetFd();
+ ServerInstance->Logs->Log("m_ident",DEBUG,"OnConnected()");
+ ServerInstance->SE->ChangeEventMask(this, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
+
+ char req[32];
+
+ /* Build request in the form 'localport,remoteport\r\n' */
+ int req_size;
+ if (user->client_sa.sa.sa_family == AF_INET6)
+ req_size = snprintf(req, sizeof(req), "%d,%d\r\n",
+ ntohs(user->client_sa.in6.sin6_port), ntohs(user->server_sa.in6.sin6_port));
+ else
+ req_size = snprintf(req, sizeof(req), "%d,%d\r\n",
+ ntohs(user->client_sa.in4.sin_port), ntohs(user->server_sa.in4.sin_port));
+
+ /* 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)
+ done = true;
}
- virtual void OnTimeout()
+ virtual void HandleEvent(EventType et, int errornum = 0)
{
- // When we timeout, the connection failed within the allowed timeframe,
- // so we just display a notice, and tidy off the ident_data.
- if (u && (Instance->SE->GetRef(ufd) == u))
+ switch (et)
{
- u->Shrink("ident_data");
- u->WriteServ("NOTICE "+std::string(u->nick)+" :*** Could not find your ident, using "+std::string(u->ident)+" instead.");
+ 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;
}
}
- virtual bool OnDataReady()
+ void Close()
{
- char* ibuf = this->Read();
- if (ibuf)
+ /* Remove ident socket from engine, and close it, but dont detatch it
+ * from its parent user class, or attempt to delete its memory.
+ */
+ if (GetFd() > -1)
{
- char* savept;
- char* section = strtok_r(ibuf,":",&savept);
- while (section)
- {
- if (strstr(section,"USERID"))
- {
- section = strtok_r(NULL,":",&savept);
- if (section)
- {
- // ID type, usually UNIX or OTHER... we dont want it, so read the next token
- section = strtok_r(NULL,":",&savept);
- if (section)
- {
- while (*section == ' ') section++; // strip leading spaces
- for (char* j = section; *j; j++)
- if ((*j < 33) || (*j > 126))
- *j = '\0'; // truncate at invalid chars
- if (*section)
- {
- if (u && (Instance->SE->GetRef(ufd) == u))
- {
- if (this->Instance->IsIdent(section))
- {
- strlcpy(u->ident,section,IDENTMAX);
- Instance->Log(DEBUG,"IDENT SET: "+std::string(u->ident));
- u->WriteServ("NOTICE "+std::string(u->nick)+" :*** Found your ident: "+std::string(u->ident));
- }
- }
- }
- return false;
- }
- }
- }
- section = strtok_r(NULL,":",&savept);
- }
+ 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);
}
- return false;
}
- virtual void OnClose()
+ bool HasResult()
{
- // tidy up after ourselves when the connection is done.
- // We receive this event straight after a timeout, too.
- //
- //
- // OK, now listen up. The weird looking check here is
- // REQUIRED. Don't try and optimize it away.
- //
- // When a socket is closed, it is not immediately removed
- // from the socket list, there can be a short delay
- // before it is culled from the list. This means that
- // without this check, there is a chance that a user
- // may not exist when we come to ::Shrink them, which
- // results in a segfault. The value of "u" may not
- // always be NULL at this point, so, what we do is
- // check against the fd_ref_table, to see if (1) the user
- // exists, and (2) its the SAME user, on the same file
- // descriptor that they were when the lookup began.
- //
- // Fixes issue reported by webs, 7 Jun 2006
- if (u && (Instance->SE->GetRef(ufd) == u))
- {
- u->Shrink("ident_data");
- }
+ return done;
}
- virtual void OnError(InspSocketError e)
+ /* Note: if the lookup succeeded, will contain 'ident', otherwise
+ * will contain '~ident'. Use *GetResult() to determine lookup success.
+ */
+ const char* GetResult()
{
- if (u && (Instance->SE->GetRef(ufd) == u))
- {
- u->Shrink("ident_data");
- }
+ return result.c_str();
}
- virtual bool OnConnected()
+ void ReadResponse()
{
- Instance->Log(DEBUG,"Ident: connected");
- if (u && (Instance->SE->GetRef(ufd) == u))
+ /* 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);
+
+ /* Cant possibly be a valid response shorter than 3 chars,
+ * because the shortest possible response would look like: '1,1'
+ */
+ if (recvresult < 3)
{
- uslen = sizeof(sock_us);
- themlen = sizeof(sock_them);
- if ((getsockname(this->u->GetFd(),(sockaddr*)&sock_us,&uslen) || getpeername(this->u->GetFd(), (sockaddr*)&sock_them, &themlen)))
+ Close();
+ done = true;
+ return;
+ }
+
+ ServerInstance->Logs->Log("m_ident",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 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++)
{
- Instance->Log(DEBUG,"Ident: failed to get socket names, bailing");
- return false;
+ if (*j == ' ')
+ continue;
+
+ /* Rules taken from InspIRCd::IsIdent */
+ if (((*j >= 'A') && (*j <= '}')) || ((*j >= '0') && (*j <= '9')) || (*j == '-') || (*j == '.'))
+ {
+ ident += *j;
+ continue;
+ }
+
+ break;
}
- else
+
+ /* Re-check with IsIdent, in case that changes and this doesn't (paranoia!) */
+ if (!ident.empty() && ServerInstance->IsIdent(ident.c_str()))
{
- // send the request in the following format: theirsocket,oursocket
-#ifdef IPV6
- snprintf(ident_request,127,"%d,%d\r\n",ntohs(sock_them.sin6_port),ntohs(sock_us.sin6_port));
-#else
- snprintf(ident_request,127,"%d,%d\r\n",ntohs(sock_them.sin_port),ntohs(sock_us.sin_port));
-#endif
- this->Write(ident_request);
- Instance->Log(DEBUG,"Sent ident request, waiting for reply");
- return true;
+ result = ident;
}
+
+ break;
}
- else
- {
- return true;
- }
+
+ /* Close (but dont delete from memory) our socket
+ * and flag as done
+ */
+ Close();
+ done = true;
+ return;
}
};
class ModuleIdent : public Module
{
-
- ConfigReader* Conf;
-
- int IdentTimeout;
-
+ int RequestTimeout;
+ ConfigReader *Conf;
+ SimpleExtItem<IdentRequestSocket> ext;
public:
- void ReadSettings()
+ ModuleIdent() : ext("ident_socket", this)
{
- Conf = new ConfigReader(ServerInstance);
- IdentTimeout = Conf->ReadInteger("ident","timeout",0,true);
- if (!IdentTimeout)
- IdentTimeout = 1;
- DELETE(Conf);
+ Conf = new ConfigReader;
+ OnRehash(NULL);
+ Implementation eventlist[] = { I_OnRehash, I_OnUserRegister, I_OnCheckReady, I_OnCleanup, I_OnUserDisconnect };
+ ServerInstance->Modules->Attach(eventlist, this, 5);
}
- ModuleIdent(InspIRCd* Me)
- : Module::Module(Me)
+ ~ModuleIdent()
{
-
- ReadSettings();
+ delete Conf;
}
- void Implements(char* List)
+ virtual Version GetVersion()
{
- List[I_OnCleanup] = List[I_OnRehash] = List[I_OnUserRegister] = List[I_OnCheckReady] = List[I_OnUserDisconnect] = 1;
+ return Version("Provides support for RFC1413 ident lookups", VF_VENDOR, API_VERSION);
}
- virtual void OnRehash(const std::string ¶meter)
+ virtual void OnRehash(User *user)
{
- ReadSettings();
+ delete Conf;
+ Conf = new ConfigReader;
+
+ RequestTimeout = Conf->ReadInteger("ident", "timeout", 0, true);
+ if (!RequestTimeout)
+ RequestTimeout = 5;
}
- virtual void OnUserRegister(userrec* user)
+ virtual ModResult OnUserRegister(User *user)
{
- /*
- * when the new user connects, before they authenticate with USER/NICK/PASS, we do
- * their ident lookup. We do this by instantiating an object of type RFC1413, which
- * is derived from InspSocket, and inserting it into the socket engine using the
- * Server::AddSocket() call.
- */
- user->WriteServ("NOTICE "+std::string(user->nick)+" :*** Looking up your ident...");
- RFC1413* ident = new RFC1413(ServerInstance, user, IdentTimeout);
- if ((ident->GetState() == I_CONNECTING) || (ident->GetState() == I_CONNECTED))
+ for (int j = 0; j < Conf->Enumerate("connect"); j++)
{
- user->Extend("ident_data", (char*)ident);
+ 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;
+ }
}
- else
- delete ident;
- }
- virtual bool OnCheckReady(userrec* user)
- {
- /*
- * The socket engine will clean up their ident request for us when it completes,
- * either due to timeout or due to closing, so, we just hold them until they dont
- * have an ident field any more.
- */
- RFC1413* ident;
- return (!user->GetExt("ident_data", ident));
- }
+ /* 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, "~");
- virtual void OnCleanup(int target_type, void* item)
- {
- if (target_type == TYPE_USER)
+ user->WriteServ("NOTICE Auth :*** Looking up your ident...");
+
+ try
{
- userrec* user = (userrec*)item;
- RFC1413* ident;
- if (user->GetExt("ident_data", ident))
- {
- // FIX: If the user record is deleted, the socket wont be removed
- // immediately so there is chance of the socket trying to write to
- // a user which has now vanished! To prevent this, set ident::u
- // to NULL and check it so that we dont write users who have gone away.
- ident->u = NULL;
- }
+ IdentRequestSocket *isock = new IdentRequestSocket(user);
+ ext.set(user, isock);
}
+ catch (ModuleException &e)
+ {
+ ServerInstance->Logs->Log("m_ident",DEBUG,"Ident exception: %s", e.GetReason());
+ }
+
+ return MOD_RES_PASSTHRU;
}
- virtual void OnUserDisconnect(userrec* user)
+ /* 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)
{
- /*
- * when the user quits tidy up any ident lookup they have pending to keep things tidy.
- * When we call RemoveSocket, the abstractions tied into the system evnetually work their
- * way to RFC1459::OnClose(), which shrinks off the ident_data for us, so we dont need
- * to do it here. If we don't tidy this up, there may still be lingering idents for users
- * who have quit, as class RFC1459 is only loosely bound to userrec* via a pair of pointers
- * and this would leave at least one of the invalid ;)
- */
- RFC1413* ident;
- if (user->GetExt("ident_data", ident))
+ /* Does user have an ident socket attached at all? */
+ IdentRequestSocket *isock = ext.get(user);
+ if (!isock)
{
- ident->u = NULL;
+ ServerInstance->Logs->Log("m_ident",DEBUG, "No ident socket :(");
+ return MOD_RES_PASSTHRU;
}
- }
-
- virtual ~ModuleIdent()
- {
- }
-
- virtual Version GetVersion()
- {
- return Version(1,5,0,0,VF_VENDOR);
- }
-
-};
-class ModuleIdentFactory : public ModuleFactory
-{
- public:
- ModuleIdentFactory()
- {
+ ServerInstance->Logs->Log("m_ident",DEBUG, "Has ident_socket");
+
+ time_t compare = isock->age;
+ compare += RequestTimeout;
+
+ /* Check for timeout of the socket */
+ 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;
+ }
+
+ /* Got a result yet? */
+ if (!isock->HasResult())
+ {
+ ServerInstance->Logs->Log("m_ident",DEBUG, "No result yet");
+ 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());
+ 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());
+
+ /* The user isnt actually disconnecting, we call this to clean up the user */
+ OnUserDisconnect(user);
+ return MOD_RES_PASSTHRU;
}
-
- ~ModuleIdentFactory()
+
+ virtual void OnCleanup(int target_type, void *item)
{
+ /* Module unloading, tidy up users */
+ if (target_type == TYPE_USER)
+ OnUserDisconnect((User*)item);
}
-
- virtual Module * CreateModule(InspIRCd* Me)
+
+ virtual void OnUserDisconnect(User *user)
{
- return new ModuleIdent(Me);
+ /* User disconnect (generic socket detatch event) */
+ IdentRequestSocket *isock = ext.get(user);
+ if (isock)
+ {
+ isock->Close();
+ ext.unset(user);
+ }
}
-
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleIdentFactory;
-}
+MODULE_INIT(ModuleIdent)
projects / user / henk / code / inspircd.git / blobdiff