* | 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-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/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 "inspircd.h"
#include "users.h"
#include "channels.h"
#include "modules.h"
-#include "inspircd.h"
-extern InspIRCd* ServerInstance;
+/* $ModDesc: Provides support for RFC1413 ident lookups */
-extern userrec* fd_ref_table[MAX_DESCRIPTORS];
+/* --------------------------------------------------------------
+ * 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.
+ * --------------------------------------------------------------
+ */
-/* $ModDesc: Provides support for RFC 1413 ident lookups */
+class IdentRequestSocket : public EventHandler
+{
+ private:
-// Version 1.5.0.0 - Updated to use InspSocket, faster and neater.
+ 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 */
-class RFC1413 : public InspSocket
-{
- protected:
- Server* Srv; // 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
public:
- userrec* u; // user record that the lookup is associated with
- int ufd;
-
- RFC1413(InspIRCd* SI, userrec* user, int maxtime, Server* S) : InspSocket(SI, user->GetIPString(), 113, false, maxtime), Srv(S), u(user), ufd(user->fd)
+ IdentRequestSocket(InspIRCd *Server, User* u, const std::string &bindip) : user(u), ServerInstance(Server), result(u->ident)
{
- log(DEBUG,"Ident: associated.");
- }
+ socklen_t size = 0;
+#ifdef IPV6
+ /* Does this look like a v6 ip address? */
+ bool v6 = false;
+ if ((bindip.empty()) || bindip.find(':') != std::string::npos)
+ v6 = true;
- virtual void OnTimeout()
- {
- // When we timeout, the connection failed within the allowed timeframe,
- // so we just display a notice, and tidy off the ident_data.
- if (u && (fd_ref_table[ufd] == u))
+ if (v6)
+ SetFd(socket(AF_INET6, SOCK_STREAM, 0));
+ else
+#endif
+ SetFd(socket(AF_INET, SOCK_STREAM, 0));
+
+ if (GetFd() == -1)
+ throw ModuleException("Could not create socket");
+
+ /* We allocate two of these because sizeof(sockaddr_in6) > sizeof(sockaddr_in) */
+ sockaddr* s = new sockaddr[2];
+ sockaddr* addr = new sockaddr[2];
+
+#ifdef IPV6
+ /* Horrid icky nasty ugly berkely socket crap. */
+ if (v6)
{
- u->Shrink("ident_data");
- u->WriteServ("NOTICE "+std::string(u->nick)+" :*** Could not find your ident, using "+std::string(u->ident)+" instead.");
+ in6_addr addy;
+ in6_addr n;
+ if (inet_pton(AF_INET6, user->GetIPString(), &addy) > 0)
+ {
+ ((sockaddr_in6*)addr)->sin6_family = AF_INET6;
+ memcpy(&((sockaddr_in6*)addr)->sin6_addr, &addy, sizeof(addy));
+ ((sockaddr_in6*)addr)->sin6_port = htons(113);
+ size = sizeof(sockaddr_in6);
+ inet_pton(AF_INET6, bindip.c_str(), &n);
+ memcpy(&((sockaddr_in6*)s)->sin6_addr, &n, sizeof(sockaddr_in6));
+ ((sockaddr_in6*)s)->sin6_port = 0;
+ ((sockaddr_in6*)s)->sin6_family = AF_INET6;
+ }
}
- }
-
- virtual bool OnDataReady()
- {
- char* ibuf = this->Read();
- if (ibuf)
+ else
+#endif
{
- char* savept;
- char* section = strtok_r(ibuf,":",&savept);
- while (section)
+ in_addr addy;
+ in_addr n;
+ if (inet_aton(user->GetIPString(), &addy) > 0)
{
- 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 && (fd_ref_table[ufd] == u))
- {
- strlcpy(u->ident,section,IDENTMAX);
- 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);
+ ((sockaddr_in*)addr)->sin_family = AF_INET;
+ ((sockaddr_in*)addr)->sin_addr = addy;
+ ((sockaddr_in*)addr)->sin_port = htons(113);
+ size = sizeof(sockaddr_in);
+ inet_aton(bindip.c_str(), &n);
+ ((sockaddr_in*)s)->sin_addr = n;
+ ((sockaddr_in*)s)->sin_port = 0;
+ ((sockaddr_in*)s)->sin_family = AF_INET;
}
}
- return false;
- }
- virtual void OnClose()
- {
- // 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 && (fd_ref_table[ufd] == u))
+ /* Attempt to bind (ident requests must come from the ip the query is referring to */
+ if (ServerInstance->SE->Bind(GetFd(), s, size) < 0)
{
- u->Shrink("ident_data");
+ this->Close();
+ delete[] s;
+ delete[] addr;
+ throw ModuleException("failed to bind()");
}
- }
- virtual void OnError(InspSocketError e)
- {
- if (u && (fd_ref_table[ufd] == u))
+ delete[] s;
+ ServerInstance->SE->NonBlocking(GetFd());
+
+ /* Attempt connection (nonblocking) */
+ if (ServerInstance->SE->Connect(this, (sockaddr*)addr, size) == -1 && errno != EINPROGRESS)
+ {
+ this->Close();
+ delete[] addr;
+ throw ModuleException("connect() failed");
+ }
+
+ delete[] addr;
+
+ /* Add fd to socket engine */
+ if (!ServerInstance->SE->AddFd(this))
{
- u->Shrink("ident_data");
+ 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 bool OnConnected()
+ virtual void OnConnected()
{
- if (u && (fd_ref_table[ufd] == u))
+ ServerInstance->Logs->Log("m_ident",DEBUG,"OnConnected()");
+
+ /* Both sockaddr_in and sockaddr_in6 can be safely casted to sockaddr, especially since the
+ * only members we use are in a part of the struct that should always be identical (at the
+ * byte level). */
+ #ifndef IPV6
+ sockaddr_in laddr, raddr;
+ #else
+ sockaddr_in6 laddr, raddr;
+ #endif
+
+ socklen_t laddrsz = sizeof(laddr);
+ socklen_t raddrsz = sizeof(raddr);
+
+ if ((getsockname(user->GetFd(), (sockaddr*) &laddr, &laddrsz) != 0) || (getpeername(user->GetFd(), (sockaddr*) &raddr, &raddrsz) != 0))
{
- uslen = sizeof(sock_us);
- themlen = sizeof(sock_them);
- if ((getsockname(this->u->fd,(sockaddr*)&sock_us,&uslen) || getpeername(this->u->fd, (sockaddr*)&sock_them, &themlen)))
- {
- log(DEBUG,"Ident: failed to get socket names, bailing");
- return false;
- }
- else
- {
- // 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);
- log(DEBUG,"Sent ident request, waiting for reply");
- return true;
- }
+ done = true;
+ return;
}
- else
- {
- return true;
- }
- }
-};
-class ModuleIdent : public Module
-{
+ char req[32];
- ConfigReader* Conf;
- Server* Srv;
- int IdentTimeout;
+ /* Build request in the form 'localport,remoteport\r\n' */
+ #ifndef IPV6
+ int req_size = snprintf(req, sizeof(req), "%d,%d\r\n", ntohs(raddr.sin_port), ntohs(laddr.sin_port));
+ #else
+ int req_size = snprintf(req, sizeof(req), "%d,%d\r\n", ntohs(raddr.sin6_port), ntohs(laddr.sin6_port));
+ #endif
+
+ /* 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;
+ }
- public:
- void ReadSettings()
+ virtual void HandleEvent(EventType et, int errornum = 0)
{
- Conf = new ConfigReader;
- IdentTimeout = Conf->ReadInteger("ident","timeout",0,true);
- if (!IdentTimeout)
- IdentTimeout = 1;
- DELETE(Conf);
+ 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;
+ }
}
- ModuleIdent(Server* Me)
- : Module::Module(Me)
+ void Close()
{
- Srv = Me;
- ReadSettings();
+ /* 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)
+ {
+ 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);
+ }
}
- void Implements(char* List)
+ bool HasResult()
{
- List[I_OnCleanup] = List[I_OnRehash] = List[I_OnUserRegister] = List[I_OnCheckReady] = List[I_OnUserDisconnect] = 1;
+ return done;
}
- virtual void OnRehash(const std::string ¶meter)
+ /* Note: if the lookup succeeded, will contain 'ident', otherwise
+ * will contain '~ident'. Use *GetResult() to determine lookup success.
+ */
+ const char* GetResult()
{
- ReadSettings();
+ return result.c_str();
}
- virtual void OnUserRegister(userrec* user)
+ void ReadResponse()
{
- /*
- * 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.
+ /* 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
*/
- user->WriteServ("NOTICE "+std::string(user->nick)+" :*** Looking up your ident...");
- RFC1413* ident = new RFC1413(ServerInstance, user, IdentTimeout, Srv);
- if (ident->GetState() != I_ERROR)
- {
- user->Extend("ident_data", (char*)ident);
- Srv->AddSocket(ident);
- }
- else
+ 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)
{
- user->WriteServ("NOTICE "+std::string(user->nick)+" :*** Could not find your ident, using "+std::string(user->ident)+" instead.");
- DELETE(ident);
+ Close();
+ done = true;
+ return;
}
- }
- 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));
- }
+ ServerInstance->Logs->Log("m_ident",DEBUG,"ReadResponse()");
- virtual void OnCleanup(int target_type, void* item)
- {
- if (target_type == TYPE_USER)
+ irc::sepstream sep(ibuf, ':');
+ std::string token;
+ for (int i = 0; sep.GetToken(token); i++)
{
- userrec* user = (userrec*)item;
- RFC1413* ident;
- if (user->GetExt("ident_data", ident))
+ /* We only really care about the 4th portion */
+ if (i < 3)
+ continue;
+
+ char ident[IDENTMAX + 2];
+
+ /* Truncate the ident at any characters we don't like, skip leading spaces */
+ int k = 0;
+ for (const char *j = token.c_str(); *j && (k < IDENTMAX + 1); j++)
{
- // 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;
- Srv->RemoveSocket(ident);
+ if (*j == ' ')
+ continue;
+
+ /* Rules taken from InspIRCd::IsIdent */
+ if (((*j >= 'A') && (*j <= '}')) || ((*j >= '0') && (*j <= '9')) || (*j == '-') || (*j == '.'))
+ {
+ ident[k++] = *j;
+ continue;
+ }
+
+ break;
}
+
+ ident[k] = '\0';
+
+ /* Re-check with IsIdent, in case that changes and this doesn't (paranoia!) */
+ if (*ident && ServerInstance->IsIdent(ident))
+ {
+ result = ident;
+ }
+
+ break;
}
+
+ /* Close (but dont delete from memory) our socket
+ * and flag as done
+ */
+ Close();
+ done = true;
+ return;
}
+};
- virtual void OnUserDisconnect(userrec* user)
+class ModuleIdent : public Module
+{
+ private:
+ int RequestTimeout;
+ public:
+ ModuleIdent(InspIRCd *Me)
+ : Module(Me)
{
- /*
- * 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))
- {
- ident->u = NULL;
- Srv->RemoveSocket(ident);
- }
+ OnRehash(NULL, "");
+ Implementation eventlist[] = { I_OnRehash, I_OnUserRegister, I_OnCheckReady, I_OnCleanup, I_OnUserDisconnect };
+ ServerInstance->Modules->Attach(eventlist, this, 5);
}
- virtual ~ModuleIdent()
+ virtual Version GetVersion()
{
+ return Version(1, 2, 1, 0, VF_VENDOR, API_VERSION);
}
- virtual Version GetVersion()
+
+ virtual void OnRehash(User *user, const std::string ¶m)
{
- return Version(1,5,0,0,VF_VENDOR);
+ ConfigReader MyConf(ServerInstance);
+
+ RequestTimeout = MyConf.ReadInteger("ident", "timeout", 0, true);
+ if (!RequestTimeout)
+ RequestTimeout = 5;
}
-};
+ virtual int OnUserRegister(User *user)
+ {
+ /* 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. */
+ memmove(user->ident + 1, user->ident, IDENTMAX);
+ user->ident[0] = '~';
+ /* Ensure that it is null terminated */
+ user->ident[IDENTMAX + 1] = '\0';
-class ModuleIdentFactory : public ModuleFactory
-{
- public:
- ModuleIdentFactory()
+ user->WriteServ("NOTICE Auth :*** Looking up your ident...");
+
+ // Get the IP that the user is connected to, and bind to that for the outgoing connection
+ #ifndef IPV6
+ sockaddr_in laddr;
+ #else
+ sockaddr_in6 laddr;
+ #endif
+ socklen_t laddrsz = sizeof(laddr);
+
+ if (getsockname(user->GetFd(), (sockaddr*) &laddr, &laddrsz) != 0)
+ {
+ user->WriteServ("NOTICE Auth :*** Could not find your ident, using %s instead.", user->ident);
+ return 0;
+ }
+
+ #ifndef IPV6
+ const char *ip = inet_ntoa(laddr.sin_addr);
+ #else
+ char ip[INET6_ADDRSTRLEN + 1];
+ inet_ntop(laddr.sin6_family, &laddr.sin6_addr, ip, INET6_ADDRSTRLEN);
+ #endif
+
+ IdentRequestSocket *isock = NULL;
+ try
+ {
+ isock = new IdentRequestSocket(ServerInstance, user, ip);
+ }
+ catch (ModuleException &e)
+ {
+ ServerInstance->Logs->Log("m_ident",DEBUG,"Ident exception: %s", e.GetReason());
+ return 0;
+ }
+
+ user->Extend("ident_socket", isock);
+ return 0;
+ }
+
+ /* 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 bool OnCheckReady(User *user)
{
+ ServerInstance->Logs->Log("m_ident",DEBUG,"OnCheckReady %s", user->nick);
+
+ /* Does user have an ident socket attached at all? */
+ IdentRequestSocket *isock = NULL;
+ if (!user->GetExt("ident_socket", isock))
+ {
+ ServerInstance->Logs->Log("m_ident",DEBUG, "No ident socket :(");
+ return true;
+ }
+
+ 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 true;
+ }
+
+ /* Got a result yet? */
+ if (!isock->HasResult())
+ {
+ ServerInstance->Logs->Log("m_ident",DEBUG, "No result yet");
+ return false;
+ }
+
+ 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 */
+ strlcpy(user->ident, isock->GetResult(), IDENTMAX+1);
+
+ /* The user isnt actually disconnecting, we call this to clean up the user */
+ OnUserDisconnect(user);
+ return true;
}
-
- ~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(Server* Me)
+
+ virtual void OnUserDisconnect(User *user)
{
- return new ModuleIdent(Me);
+ /* User disconnect (generic socket detatch event) */
+ IdentRequestSocket *isock = NULL;
+ if (user->GetExt("ident_socket", isock))
+ {
+ isock->Close();
+ delete isock;
+ user->Shrink("ident_socket");
+ ServerInstance->Logs->Log("m_ident",DEBUG, "Removed ident socket from %s", user->nick);
+ }
}
-
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleIdentFactory;
-}
+MODULE_INIT(ModuleIdent)
projects / user / henk / code / inspircd.git / blobdiff