/*
* InspIRCd -- Internet Relay Chat Daemon
*
+ * Copyright (C) 2013, 2018-2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012-2015 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012-2013 Robby <robby@chatbelgie.be>
* 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) 2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007, 2010 Craig Edwards <brain@inspircd.org>
+ * Copyright (C) 2007 John Brooks <special@inspircd.org>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
#include "inspircd.h"
-/* $ModDesc: Provides support for RFC1413 ident lookups */
+enum
+{
+ // Either the ident looup has not started yet or the user is registered.
+ IDENT_UNKNOWN = 0,
+
+ // Ident lookups are not enabled and a user has been marked as being skipped.
+ IDENT_SKIPPED,
+
+ // Ident looups are not enabled and a user has been an insecure ident prefix.
+ IDENT_PREFIXED,
+
+ // An ident lookup was done and an ident was found.
+ IDENT_FOUND,
+
+ // An ident lookup was done but no ident was found
+ IDENT_MISSING
+};
/* --------------------------------------------------------------
* Note that this is the third incarnation of m_ident. The first
* 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!
+ * queued for deletion, etc. In fact, there's not even any queueing!
*
* Using this framework we have a much more stable module.
*
{
age = ServerInstance->Time();
- SetFd(socket(user->server_sa.sa.sa_family, SOCK_STREAM, 0));
-
- if (GetFd() == -1)
+ SetFd(socket(user->server_sa.family(), SOCK_STREAM, 0));
+ if (!HasFd())
throw ModuleException("Could not create socket");
done = false;
memcpy(&bindaddr, &user->server_sa, sizeof(bindaddr));
memcpy(&connaddr, &user->client_sa, sizeof(connaddr));
- if (connaddr.sa.sa_family == AF_INET6)
+ if (connaddr.family() == AF_INET6)
{
bindaddr.in6.sin6_port = 0;
connaddr.in6.sin6_port = htons(113);
}
/* Attempt to bind (ident requests must come from the ip the query is referring to */
- if (ServerInstance->SE->Bind(GetFd(), bindaddr) < 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, connaddr.sa_size()) == -1 && errno != EINPROGRESS)
+ if (SocketEngine::Connect(this, connaddr) == -1 && errno != EINPROGRESS)
{
this->Close();
throw ModuleException("connect() failed");
}
/* Add fd to socket engine */
- if (!ServerInstance->SE->AddFd(this, FD_WANT_NO_READ | FD_WANT_POLL_WRITE))
+ if (!SocketEngine::AddFd(this, FD_WANT_NO_READ | FD_WANT_POLL_WRITE))
{
this->Close();
throw ModuleException("out of fds");
}
}
- virtual void OnConnected()
+ void OnEventHandlerWrite() CXX11_OVERRIDE
{
- ServerInstance->Logs->Log("m_ident",DEBUG,"OnConnected()");
- ServerInstance->SE->ChangeEventMask(this, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
+ SocketEngine::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)
+ if (user->client_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
/* 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
+ /* Remove ident socket from engine, and close it, but dont detach it
* from its parent user class, or attempt to delete its memory.
*/
- if (GetFd() > -1)
+ if (HasFd())
{
- ServerInstance->Logs->Log("m_ident",DEBUG,"Close ident socket %d", GetFd());
- ServerInstance->SE->DelFd(this);
- ServerInstance->SE->Close(GetFd());
- this->SetFd(-1);
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Close ident socket %d", GetFd());
+ SocketEngine::Close(this);
}
}
return done;
}
- 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;
- SimpleExtItem<IdentRequestSocket> ext;
- public:
- ModuleIdent() : ext("ident_socket", this)
+ private:
+ unsigned int timeout;
+ bool prefixunqueried;
+ SimpleExtItem<IdentRequestSocket, stdalgo::culldeleter> socket;
+ LocalIntExt state;
+
+ static void PrefixIdent(LocalUser* user)
{
- OnRehash(NULL);
- Implementation eventlist[] = {
- I_OnRehash, I_OnUserInit, I_OnCheckReady,
- I_OnUserDisconnect, I_OnSetConnectClass
- };
- ServerInstance->Modules->Attach(eventlist, this, 5);
+ // Check that they haven't been prefixed already.
+ if (user->ident[0] == '~')
+ return;
+
+ // All invalid usernames are prefixed with a tilde.
+ std::string newident(user->ident);
+ newident.insert(newident.begin(), '~');
+
+ // If the username is too long then truncate it.
+ if (newident.length() > ServerInstance->Config->Limits.IdentMax)
+ newident.erase(ServerInstance->Config->Limits.IdentMax);
+
+ // Apply the new username.
+ user->ChangeIdent(newident);
}
- ~ModuleIdent()
+ public:
+ ModuleIdent()
+ : socket("ident_socket", ExtensionItem::EXT_USER, this)
+ , state("ident_state", ExtensionItem::EXT_USER, this)
{
}
- virtual Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version("Provides support for RFC1413 ident lookups", VF_VENDOR);
+ return Version("Allows the usernames (idents) of users to be looked up using the RFC 1413 Identification Protocol.", VF_VENDOR);
}
- virtual void OnRehash(User *user)
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- ConfigReader Conf;
-
- RequestTimeout = Conf.ReadInteger("ident", "timeout", 0, true);
- if (!RequestTimeout)
- RequestTimeout = 5;
+ ConfigTag* tag = ServerInstance->Config->ConfValue("ident");
+ timeout = tag->getDuration("timeout", 5, 1, 60);
+ prefixunqueried = tag->getBool("prefixunqueried");
}
- void OnUserInit(LocalUser *user)
+ void OnSetUserIP(LocalUser* user) CXX11_OVERRIDE
{
+ IdentRequestSocket* isock = socket.get(user);
+ if (isock)
+ {
+ // If an ident lookup request was in progress then cancel it.
+ isock->Close();
+ socket.unset(user);
+ }
+
+ // The ident protocol requires that clients are connecting over a protocol with ports.
+ if (user->client_sa.family() != AF_INET && user->client_sa.family() != AF_INET6)
+ return;
+
+ // We don't want to look this up once the user has connected.
+ if (user->registered == REG_ALL || user->quitting)
+ return;
+
ConfigTag* tag = user->MyClass->config;
if (!tag->getBool("useident", true))
+ {
+ state.set(user, IDENT_SKIPPED);
return;
+ }
- user->WriteServ("NOTICE Auth :*** Looking up your ident...");
+ user->WriteNotice("*** Looking up your ident...");
try
{
- IdentRequestSocket *isock = new IdentRequestSocket(IS_LOCAL(user));
- ext.set(user, isock);
+ isock = new IdentRequestSocket(user);
+ socket.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());
}
}
* creating a Timer object and especially better than creating a
* Timer per ident lookup!
*/
- virtual ModResult OnCheckReady(LocalUser *user)
+ ModResult OnCheckReady(LocalUser *user) CXX11_OVERRIDE
{
/* Does user have an ident socket attached at all? */
- IdentRequestSocket *isock = ext.get(user);
+ IdentRequestSocket* isock = socket.get(user);
if (!isock)
{
- ServerInstance->Logs->Log("m_ident",DEBUG, "No ident socket :(");
+ if (prefixunqueried && state.get(user) == IDENT_SKIPPED)
+ {
+ PrefixIdent(user);
+ state.set(user, IDENT_PREFIXED);
+ }
return MOD_RES_PASSTHRU;
}
- ServerInstance->Logs->Log("m_ident",DEBUG, "Has ident_socket");
-
- time_t compare = isock->age;
- compare += RequestTimeout;
+ time_t compare = isock->age + timeout;
/* 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");
+ state.set(user, IDENT_MISSING);
+ PrefixIdent(user);
+ user->WriteNotice("*** Ident lookup timed out, using " + user->ident + " instead.");
}
else if (!isock->HasResult())
{
// time still good, no result yet... hold the registration
- 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->result.empty())
+ else if (isock->result.empty())
{
- user->ident.insert(0, 1, '~');
- user->WriteServ("NOTICE Auth :*** Could not find your ident, using %s instead.", user->ident.c_str());
+ state.set(user, IDENT_MISSING);
+ PrefixIdent(user);
+ user->WriteNotice("*** Could not find your ident, using " + user->ident + " instead.");
}
else
{
- user->ident = isock->result;
- user->WriteServ("NOTICE Auth :*** Found your ident, '%s'", user->ident.c_str());
+ state.set(user, IDENT_FOUND);
+ user->ChangeIdent(isock->result);
+ user->WriteNotice("*** Found your ident, '" + user->ident + "'");
}
isock->Close();
- ext.unset(user);
+ socket.unset(user);
return MOD_RES_PASSTHRU;
}
- ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass)
+ ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
{
- if (myclass->config->getBool("requireident") && user->ident[0] == '~')
+ if (myclass->config->getBool("requireident") && state.get(user) != IDENT_FOUND)
+ {
+ ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as it requires an identd response",
+ myclass->GetName().c_str());
return MOD_RES_DENY;
+ }
return MOD_RES_PASSTHRU;
}
- virtual void OnCleanup(int target_type, void *item)
+ void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
{
- /* Module unloading, tidy up users */
- if (target_type == TYPE_USER)
- OnUserDisconnect((LocalUser*)item);
- }
-
- virtual void OnUserDisconnect(LocalUser *user)
- {
- /* User disconnect (generic socket detatch event) */
- IdentRequestSocket *isock = ext.get(user);
- if (isock)
- {
- isock->Close();
- ext.unset(user);
- }
+ // Clear this as it is no longer necessary.
+ state.unset(user);
}
};
MODULE_INIT(ModuleIdent)
-
projects / user / henk / code / inspircd.git / blobdiff