* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * Inspire is copyright (C) 2002-2004 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.
*
* ---------------------------------------------------
*/
-#include <stdio.h>
-#include <string>
-#include <stdlib.h>
-#include <time.h>
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <sys/time.h>
-#include <string.h>
-#include <unistd.h>
-#include <errno.h>
-#include <fcntl.h>
-#include <poll.h>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
#include "inspircd.h"
-/* $ModDesc: Provides support for RFC 1413 ident lookups */
-
-Server *Srv;
+/* $ModDesc: Provides support for RFC1413 ident lookups */
-// Ident lookups are done by attaching an RFC1413 class to the
-// userrec record using the Extensible system.
-// The RFC1413 class is written especially for this module but
-// it should be relatively standalone for anyone else who wishes
-// to have a nonblocking ident lookup in a program :)
-// the class operates on a simple state engine, each state of the
-// connection incrementing a state counter, leading through to
-// a concluding state which terminates the lookup.
+/* --------------------------------------------------------------
+ * 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
+class IdentRequestSocket : public EventHandler
{
- protected:
- int fd; // file descriptor
- userrec* u; // user record that the lookup is associated with
- sockaddr_in addr; // address we're connecting to
- in_addr addy; // binary ip address
- int state; // state (this class operates on a state engine)
- char ibuf[MAXBUF]; // input buffer
- sockaddr_in sock_us; // our port number
- sockaddr_in sock_them; // their port number
- socklen_t uslen; // length of our port number
- socklen_t themlen; // length of their port number
- int nrecv; // how many bytes we've received
- time_t timeout_end; // how long until the operation times out
- bool timeout; // true if we've timed out and should bail
+ 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:
- // establish an ident connection, maxtime is the time to spend trying
- // returns true if successful, false if something was catastrophically wrong.
- // note that failed connects are not reported here but detected in RFC1413::Poll()
- // as the socket is nonblocking
-
- bool Connect(userrec* user, int maxtime)
+ IdentRequestSocket(InspIRCd *Server, User* u, const std::string &bindip) : user(u), ServerInstance(Server), result(u->ident)
{
- timeout_end = time(NULL)+maxtime;
- timeout = false;
- if ((this->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
- {
- Srv->Log(DEBUG,"Ident: socket failed for: "+std::string(user->ip));
- return false;
- }
- inet_aton(user->ip,&addy);
- addr.sin_family = AF_INET;
- addr.sin_addr = addy;
- addr.sin_port = htons(113);
+ 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;
- int flags;
- flags = fcntl(this->fd, F_GETFL, 0);
- fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
+ if (v6)
+ SetFd(socket(AF_INET6, SOCK_STREAM, 0));
+ else
+#endif
+ SetFd(socket(AF_INET, SOCK_STREAM, 0));
- if(connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
+ if (GetFd() == -1)
+ throw ModuleException("Could not create socket");
+
+ done = false;
+
+ /* We allocate two of these because sizeof(sockaddr_in6) > sizeof(sockaddr_in) */
+ irc::sockets::sockaddrs s;
+ irc::sockets::sockaddrs addr;
+
+#ifdef IPV6
+ /* Horrid icky nasty ugly berkely socket crap. */
+ if (v6)
{
- if (errno != EINPROGRESS)
+ if (inet_pton(AF_INET6, user->GetIPString(), &addr.in6.sin6_addr) > 0)
{
- Srv->Log(DEBUG,"Ident: connect failed for: "+std::string(user->ip));
- return false;
+ addr.in6.sin6_family = AF_INET6;
+ addr.in6.sin6_port = htons(113);
+ size = sizeof(sockaddr_in6);
+ inet_pton(AF_INET6, bindip.c_str(), &s.in6.sin6_addr);
+ s.in6.sin6_family = AF_INET6;
+ s.in6.sin6_port = 0;
}
- }
- Srv->Log(DEBUG,"Ident: successful connect associated with user "+std::string(user->nick));
- this->u = user;
- this->state = 1;
- return true;
+ }
+ else
+#endif
+ {
+ if (inet_aton(user->GetIPString(), &addr.in4.sin_addr) > 0)
+ {
+ addr.in4.sin_family = AF_INET;
+ addr.in4.sin_port = htons(113);
+ size = sizeof(sockaddr_in);
+ inet_aton(bindip.c_str(), &s.in4.sin_addr);
+ s.in4.sin_family = AF_INET;
+ s.in4.sin_port = 0;
+ }
+ }
+
+ /* Attempt to bind (ident requests must come from the ip the query is referring to */
+ if (ServerInstance->SE->Bind(GetFd(), &s.sa, size) < 0)
+ {
+ this->Close();
+ throw ModuleException("failed to bind()");
+ }
+
+ ServerInstance->SE->NonBlocking(GetFd());
+
+ /* Attempt connection (nonblocking) */
+ if (ServerInstance->SE->Connect(this, &addr.sa, size) == -1 && errno != EINPROGRESS)
+ {
+ this->Close();
+ throw ModuleException("connect() failed");
+ }
+
+ /* Add fd to socket engine */
+ if (!ServerInstance->SE->AddFd(this))
+ {
+ 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);
}
- // Poll the socket to see if we have an ident result, and if we do apply it to the user.
- // returns false if we cannot poll for some reason (e.g. timeout).
+ virtual void OnConnected()
+ {
+ 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). */
+ irc::sockets::sockaddrs laddr, raddr;
+
+ socklen_t laddrsz = sizeof(laddr);
+ socklen_t raddrsz = sizeof(raddr);
+
+ if ((getsockname(user->GetFd(), &laddr.sa, &laddrsz) != 0) || (getpeername(user->GetFd(), &raddr.sa, &raddrsz) != 0))
+ {
+ done = true;
+ return;
+ }
+
+ char req[32];
+
+ /* Build request in the form 'localport,remoteport\r\n' */
+ int req_size;
+#ifdef IPV6
+ if (raddr.sa.sa_family == AF_INET6)
+ req_size = snprintf(req, sizeof(req), "%d,%d\r\n", ntohs(raddr.in6.sin6_port), ntohs(laddr.in6.sin6_port));
+ else
+#endif
+ req_size = snprintf(req, sizeof(req), "%d,%d\r\n", ntohs(raddr.in4.sin_port), ntohs(laddr.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;
+ }
- bool Poll()
+ virtual void HandleEvent(EventType et, int errornum = 0)
{
- if (time(NULL) > timeout_end)
+ switch (et)
{
- timeout = true;
- Srv->SendServ(u->fd,"NOTICE "+std::string(u->nick)+" :*** Could not find your ident, using "+std::string(u->ident)+" instead.");
- return false;
+ 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;
}
- pollfd polls;
- polls.fd = this->fd;
- if (state == 1)
+ }
+
+ void Close()
+ {
+ /* 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)
{
- polls.events = POLLOUT;
+ 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);
}
- else
+ }
+
+ bool HasResult()
+ {
+ 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()
+ {
+ /* 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)
{
- polls.events = POLLIN;
+ Close();
+ done = true;
+ return;
}
- int ret = poll(&polls,1,1);
- if (ret > 0)
+ ServerInstance->Logs->Log("m_ident",DEBUG,"ReadResponse()");
+
+ irc::sepstream sep(ibuf, ':');
+ std::string token;
+ for (int i = 0; sep.GetToken(token); i++)
{
- switch (this->state)
+ /* 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++)
{
- case 1:
- Srv->Log(DEBUG,"*** IDENT IN STATE 1");
- 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)))
- {
- Srv->Log(DEBUG,"Ident: failed to get socket names, bailing to state 3");
- state = 3;
- }
- else
- {
- // send the request in the following format: theirsocket,oursocket
- Write(this->fd,"%d,%d",ntohs(sock_them.sin_port),ntohs(sock_us.sin_port));
- Srv->Log(DEBUG,"Sent ident request, moving to state 2");
- state = 2;
- }
- break;
- case 2:
- Srv->Log(DEBUG,"*** IDENT IN STATE 2");
- nrecv = recv(this->fd,ibuf,sizeof(ibuf),0);
- if (nrecv > 0)
- {
- // we have the response line in the following format:
- // 6193, 23 : USERID : UNIX : stjohns
- // 6195, 23 : ERROR : NO-USER
- ibuf[nrecv] = '\0';
- Srv->Log(DEBUG,"Received ident response: "+std::string(ibuf));
- close(this->fd);
- shutdown(this->fd,2);
- 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 == ' ') && (strlen(section)>0)) section++; // strip leading spaces
- if ((section[strlen(section)-1] == 13) || (section[strlen(section)-1] == 10))
- section[strlen(section)-1] = '\0'; // strip carriage returns
- if ((section[strlen(section)-1] == 13) || (section[strlen(section)-1] == 10))
- section[strlen(section)-1] = '\0'; // strip linefeeds
- while ((section[strlen(section)-1] == ' ') && (strlen(section)>0)) // strip trailing spaces
- section[strlen(section)-1] = '\0';
- if (strlen(section))
- {
- strlcpy(u->ident,section,IDENTMAX);
- Srv->Log(DEBUG,"IDENT SET: "+std::string(u->ident));
- Srv->SendServ(u->fd,"NOTICE "+std::string(u->nick)+" :*** Found your ident: "+std::string(u->ident));
- }
- break;
- }
- }
- }
- section = strtok_r(NULL,":",&savept);
- }
- state = 3;
- }
- break;
- case 3:
- Srv->Log(DEBUG,"Ident lookup is complete!");
- break;
- default:
- Srv->Log(DEBUG,"Ident: invalid ident state!!!");
+ if (*j == ' ')
+ continue;
+
+ /* Rules taken from InspIRCd::IsIdent */
+ if (((*j >= 'A') && (*j <= '}')) || ((*j >= '0') && (*j <= '9')) || (*j == '-') || (*j == '.'))
+ {
+ ident += *j;
+ continue;
+ }
+
break;
}
- }
- }
- // returns true if the operation is completed,
- // either due to complete request, or a timeout
+ /* Re-check with IsIdent, in case that changes and this doesn't (paranoia!) */
+ if (!ident.empty() && ServerInstance->IsIdent(ident.c_str()))
+ {
+ result = ident;
+ }
- bool Done()
- {
- return ((state == 3) || (timeout == true));
+ break;
+ }
+
+ /* Close (but dont delete from memory) our socket
+ * and flag as done
+ */
+ Close();
+ done = true;
+ return;
}
};
class ModuleIdent : public Module
{
-
- ConfigReader* Conf;
- int IdentTimeout;
-
+ private:
+ int RequestTimeout;
+ ConfigReader *Conf;
public:
- void ReadSettings()
+ ModuleIdent(InspIRCd *Me) : Module(Me)
+ {
+ 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()
{
- Conf = new ConfigReader;
- IdentTimeout = Conf->ReadInteger("ident","timeout",0,true);
delete Conf;
}
- ModuleIdent()
+ virtual Version GetVersion()
{
- Srv = new Server;
- ReadSettings();
+ return Version("$Id$", VF_VENDOR, API_VERSION);
}
- virtual void OnRehash()
+ virtual void OnRehash(User *user)
{
- ReadSettings();
+ delete Conf;
+ Conf = new ConfigReader(ServerInstance);
+
+ RequestTimeout = Conf->ReadInteger("ident", "timeout", 0, true);
+ if (!RequestTimeout)
+ RequestTimeout = 5;
}
- virtual void OnUserRegister(userrec* user)
+ virtual int OnUserRegister(User *user)
{
- // when the new user connects, before they authenticate with USER/NICK/PASS, we do
- // their ident lookup.
+ 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 0;
+ }
+ }
+
+ /* 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, "~");
+
+ user->WriteServ("NOTICE Auth :*** Looking up your ident...");
- RFC1413* ident = new RFC1413;
- Srv->SendServ(user->fd,"NOTICE "+std::string(user->nick)+" :*** Looking up your ident...");
- if (ident->Connect(user,IdentTimeout))
+ // Get the IP that the user is connected to, and bind to that for the outgoing connection
+ irc::sockets::sockaddrs laddr;
+ socklen_t laddrsz = sizeof(laddr);
+
+ if (getsockname(user->GetFd(), &laddr.sa, &laddrsz) != 0)
{
- // attach the object to the user record
- user->Extend("ident_data",(char*)ident);
- // start it off polling (always good to have a head start)
- // because usually connect has completed by now
- ident->Poll();
+ user->WriteServ("NOTICE Auth :*** Could not find your ident, using %s instead.", user->ident.c_str());
+ return 0;
}
+
+ char ip[INET6_ADDRSTRLEN + 1];
+#ifdef IPV6
+ if (laddr.sa.sa_family == AF_INET6)
+ inet_ntop(laddr.in6.sin6_family, &laddr.in6.sin6_addr, ip, INET6_ADDRSTRLEN);
else
+#endif
+ inet_ntop(laddr.in4.sin_family, &laddr.in4.sin_addr, ip, INET6_ADDRSTRLEN);
+
+ IdentRequestSocket *isock = NULL;
+ try
{
- // something went wrong, call an irc-ambulance!
- Srv->SendServ(user->fd,"NOTICE "+std::string(user->nick)+" :*** Could not look up your ident.");
- delete ident;
+ 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;
}
- virtual bool OnCheckReady(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 bool OnCheckReady(User *user)
{
- RFC1413* ident = (RFC1413*)user->GetExt("ident_data");
- if (ident)
+ /* Does user have an ident socket attached at all? */
+ IdentRequestSocket *isock = NULL;
+ if (!user->GetExt("ident_socket", isock))
{
- // this user has a pending ident lookup, poll it
- ident->Poll();
- // is it done?
- if (ident->Done())
- {
- // their ident is done, zap the structures
- Srv->Log(DEBUG,"Ident: removing ident gubbins");
- user->Shrink("ident_data");
- delete ident;
- // ...and send them on their way
- return true;
- }
- // nope, we hold them in this state, they dont go anywhere
+ 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 */
+ user->ChangeIdent(isock->GetResult());
+
+ /* The user isnt actually disconnecting, we call this to clean up the user */
+ OnUserDisconnect(user);
return true;
}
-
- virtual ~ModuleIdent()
- {
- delete Srv;
- }
-
- virtual Version GetVersion()
- {
- return Version(1,0,0,1,VF_VENDOR);
- }
-
-};
-class ModuleIdentFactory : public ModuleFactory
-{
- public:
- ModuleIdentFactory()
- {
- }
-
- ~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()
+
+ virtual void OnUserDisconnect(User *user)
{
- return new ModuleIdent;
+ /* User disconnect (generic socket detatch event) */
+ IdentRequestSocket *isock = NULL;
+ if (user->GetExt("ident_socket", isock))
+ {
+ isock->Close();
+ delete isock;
+ user->Shrink("ident_socket");
+ }
}
-
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleIdentFactory;
-}
+MODULE_INIT(ModuleIdent)
projects / user / henk / code / inspircd.git / blobdiff