-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- 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.
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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 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/>.
*/
-using namespace std;
-
-#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 */
+/* --------------------------------------------------------------
+ * 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.
+ * --------------------------------------------------------------
+ */
-Server *Srv;
+class IdentRequestSocket : public EventHandler
+{
+ 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 */
-// State engine constants. We have three states,
-// connecting, waiting for data, and finished.
+ IdentRequestSocket(LocalUser* u) : user(u)
+ {
+ age = ServerInstance->Time();
-#define IDENT_STATE_CONNECT 1
-#define IDENT_STATE_WAITDATA 2
-#define IDENT_STATE_DONE 3
+ SetFd(socket(user->server_sa.sa.sa_family, SOCK_STREAM, 0));
-// 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.
+ if (GetFd() == -1)
+ throw ModuleException("Could not create socket");
-class RFC1413
-{
- 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
- char ident_request[128]; // buffer used to make up the request string
- public:
+ done = false;
- // The destructor makes damn sure the socket is freed :)
+ irc::sockets::sockaddrs bindaddr;
+ irc::sockets::sockaddrs connaddr;
- ~RFC1413()
- {
- if (this->fd != -1)
+ memcpy(&bindaddr, &user->server_sa, sizeof(bindaddr));
+ memcpy(&connaddr, &user->client_sa, sizeof(connaddr));
+
+ if (connaddr.sa.sa_family == AF_INET6)
{
- shutdown(this->fd,2);
- close(this->fd);
- this->fd = -1;
+ bindaddr.in6.sin6_port = 0;
+ connaddr.in6.sin6_port = htons(113);
}
- }
-
- // 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)
- {
- timeout_end = time(NULL)+maxtime;
- timeout = false;
- if ((this->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
+ else
{
- // theres been a boo-boo... no more fd's left for us, woe is me!
- Srv->Log(DEBUG,"Ident: socket failed for: "+std::string(user->ip));
- return false;
+ bindaddr.in4.sin_port = 0;
+ connaddr.in4.sin_port = htons(113);
}
- inet_aton(user->ip,&addy);
- addr.sin_family = AF_INET;
- addr.sin_addr = addy;
- addr.sin_port = htons(113);
-
- int flags;
- flags = fcntl(this->fd, F_GETFL, 0);
- fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
- if(connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
+ /* Attempt to bind (ident requests must come from the ip the query is referring to */
+ if (ServerInstance->SE->Bind(GetFd(), bindaddr) < 0)
{
- // theres been an error, but EINPROGRESS just means 'right, im on it, call me later'
- if (errno != EINPROGRESS)
- {
- // ... so that error isnt fatal, like the rest.
- Srv->Log(DEBUG,"Ident: connect failed for: "+std::string(user->ip));
- shutdown(this->fd,2);
- close(this->fd);
- this->fd = -1;
- return false;
- }
- }
- Srv->Log(DEBUG,"Ident: successful connect associated with user "+std::string(user->nick));
- this->u = user;
- this->state = IDENT_STATE_CONNECT;
- return true;
- }
+ this->Close();
+ throw ModuleException("failed to bind()");
+ }
- // 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).
+ ServerInstance->SE->NonBlocking(GetFd());
- bool Poll()
- {
- if (time(NULL) > timeout_end)
+ /* Attempt connection (nonblocking) */
+ if (ServerInstance->SE->Connect(this, &connaddr.sa, connaddr.sa_size()) == -1 && errno != EINPROGRESS)
{
- timeout = true;
- Srv->SendServ(u->fd,"NOTICE "+std::string(u->nick)+" :*** Could not find your ident, using "+std::string(u->ident)+" instead.");
- shutdown(this->fd,2);
- close(this->fd);
- this->fd = -1;
- return false;
+ this->Close();
+ throw ModuleException("connect() failed");
}
- pollfd polls;
- polls.fd = this->fd;
- if (state == IDENT_STATE_CONNECT)
+
+ /* Add fd to socket engine */
+ if (!ServerInstance->SE->AddFd(this, FD_WANT_NO_READ | FD_WANT_POLL_WRITE))
{
- // during state IDENT_STATE_CONNECT (leading up to the connect)
- // we're watching for writeability
- polls.events = POLLOUT;
+ this->Close();
+ throw ModuleException("out of fds");
}
+ }
+
+ void OnConnected()
+ {
+ ServerInstance->Logs->Log(MODNAME, LOG_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;
+ }
+
+ void HandleEvent(EventType et, int errornum = 0)
+ {
+ switch (et)
{
- // the rest of the time we're waiting for data
- // back on the socket, or a socket close
- polls.events = POLLIN;
+ 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(MODNAME, LOG_DEBUG, "EVENT_ERROR");
+ /* We *must* Close() here immediately or we get a
+ * huge storm of EVENT_ERROR events!
+ */
+ Close();
+ done = true;
+ break;
}
- int ret = poll(&polls,1,1);
+ }
- if (ret > 0)
+ 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)
{
- switch (this->state)
- {
- case IDENT_STATE_CONNECT:
- 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");
- shutdown(this->fd,2);
- close(this->fd);
- this->fd = -1;
- state = IDENT_STATE_DONE;
- }
- else
- {
- // send the request in the following format: theirsocket,oursocket
- snprintf(ident_request,127,"%d,%d\r\n",ntohs(sock_them.sin_port),ntohs(sock_us.sin_port));
- send(this->fd,ident_request,strlen(ident_request),0);
- Srv->Log(DEBUG,"Sent ident request, moving to state 2");
- state = IDENT_STATE_WAITDATA;
- }
- break;
- case IDENT_STATE_WAITDATA:
- 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));
- shutdown(this->fd,2);
- close(this->fd);
- this->fd = -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 == ' ') && (strlen(section)>0)) section++; // strip leading spaces
- int t = strlen(section);
- for (int j = 0; j < t; j++)
- if ((section[j] < 33) || (section[j]>126))
- section[j] = '\0'; // truncate at invalid chars
- 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 = IDENT_STATE_DONE;
- }
- break;
- case IDENT_STATE_DONE:
- shutdown(this->fd,2);
- close(this->fd);
- this->fd = -1;
- Srv->Log(DEBUG,"Ident lookup is complete!");
- break;
- default:
- Srv->Log(DEBUG,"Ident: invalid ident state!!!");
- break;
- }
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Close ident socket %d", GetFd());
+ ServerInstance->SE->DelFd(this);
+ ServerInstance->SE->Close(GetFd());
+ this->SetFd(-1);
}
- return true;
}
- // returns true if the operation is completed,
- // either due to complete request, or a timeout
+ bool HasResult()
+ {
+ return done;
+ }
- bool Done()
+ void ReadResponse()
{
- return ((state == IDENT_STATE_DONE) || (timeout == true));
+ /* 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[256];
+ int recvresult = ServerInstance->SE->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)
+ return;
+
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "ReadResponse()");
+
+ /* 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);
+
+ /* <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;
+
+ 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;
+
+ 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.erase(result.end()-1);
+ break;
+ }
+ }
}
};
class ModuleIdent : public Module
{
-
- ConfigReader* Conf;
- int IdentTimeout;
-
+ int RequestTimeout;
+ SimpleExtItem<IdentRequestSocket> ext;
public:
- void ReadSettings()
+ ModuleIdent() : ext("ident_socket", this)
{
- Conf = new ConfigReader;
- IdentTimeout = Conf->ReadInteger("ident","timeout",0,true);
- delete Conf;
}
- ModuleIdent(Server* Me)
- : Module::Module(Me)
+ Version GetVersion() CXX11_OVERRIDE
{
- Srv = Me;
- ReadSettings();
+ return Version("Provides support for RFC1413 ident lookups", VF_VENDOR);
}
- void Implements(char* List)
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- List[I_OnRehash] = List[I_OnUserRegister] = List[I_OnCheckReady] = List[I_OnUserDisconnect] = 1;
+ RequestTimeout = ServerInstance->Config->ConfValue("ident")->getInt("timeout", 5);
+ if (!RequestTimeout)
+ RequestTimeout = 5;
}
- virtual void OnRehash(std::string parameter)
+ void OnUserInit(LocalUser *user) CXX11_OVERRIDE
{
- ReadSettings();
- }
+ ConfigTag* tag = user->MyClass->config;
+ if (!tag->getBool("useident", true))
+ return;
- virtual void OnUserRegister(userrec* user)
- {
- // when the new user connects, before they authenticate with USER/NICK/PASS, we do
- // their ident lookup.
+ user->WriteNotice("*** 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))
+ try
{
- // 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();
+ IdentRequestSocket *isock = new IdentRequestSocket(IS_LOCAL(user));
+ ext.set(user, isock);
}
- else
+ catch (ModuleException &e)
{
- // something went wrong, call an irc-ambulance!
- Srv->SendServ(user->fd,"NOTICE "+std::string(user->nick)+" :*** Could not look up your ident.");
- delete ident;
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Ident exception: %s", e.GetReason());
}
}
- 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!
+ */
+ ModResult OnCheckReady(LocalUser *user) CXX11_OVERRIDE
{
- RFC1413* ident = (RFC1413*)user->GetExt("ident_data");
- if (ident)
+ /* Does user have an ident socket attached at all? */
+ IdentRequestSocket *isock = ext.get(user);
+ if (!isock)
+ return MOD_RES_PASSTHRU;
+
+ time_t compare = isock->age;
+ compare += RequestTimeout;
+
+ /* Check for timeout of the socket */
+ if (ServerInstance->Time() >= compare)
{
- // 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
- return false;
+ /* Ident timeout */
+ user->WriteNotice("*** Ident request timed out.");
+ }
+ else if (!isock->HasResult())
+ {
+ // time still good, no result yet... hold the registration
+ return MOD_RES_DENY;
}
- return true;
- }
- virtual void OnUserDisconnect(userrec* user)
- {
- // when the user quits tidy up any ident lookup they have pending to keep things tidy
- // and to prevent a memory and FD leaks
- RFC1413* ident = (RFC1413*)user->GetExt("ident_data");
- if (ident)
- {
- delete ident;
- user->Shrink("ident_data");
- }
- }
-
- virtual ~ModuleIdent()
- {
- }
-
- virtual Version GetVersion()
- {
- return Version(1,0,0,1,VF_VENDOR);
+ /* wooo, got a result (it will be good, or bad) */
+ if (isock->result.empty())
+ {
+ user->ident.insert(0, 1, '~');
+ user->WriteNotice("*** Could not find your ident, using " + user->ident + " instead.");
+ }
+ else
+ {
+ user->ident = isock->result;
+ user->WriteNotice("*** Found your ident, '" + user->ident + "'");
+ }
+
+ user->InvalidateCache();
+ isock->Close();
+ ext.unset(user);
+ return MOD_RES_PASSTHRU;
}
-
-};
-class ModuleIdentFactory : public ModuleFactory
-{
- public:
- ModuleIdentFactory()
+ ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
{
+ if (myclass->config->getBool("requireident") && user->ident[0] == '~')
+ return MOD_RES_DENY;
+ return MOD_RES_PASSTHRU;
}
-
- ~ModuleIdentFactory()
+
+ void OnCleanup(int target_type, void *item) CXX11_OVERRIDE
{
+ /* Module unloading, tidy up users */
+ if (target_type == TYPE_USER)
+ {
+ LocalUser* user = IS_LOCAL((User*) item);
+ if (user)
+ OnUserDisconnect(user);
+ }
}
-
- virtual Module * CreateModule(Server* Me)
+
+ void OnUserDisconnect(LocalUser *user) CXX11_OVERRIDE
{
- 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)