* | 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-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.
*
* ---------------------------------------------------
*/
-#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 "inspircd.h"
#include "users.h"
#include "channels.h"
#include "modules.h"
-#include "inspircd.h"
-#include "m_sql.h"
+#include "m_sqlv2.h"
+#include "m_sqlutils.h"
+#include "m_hash.h"
-/* $ModDesc: An SQL test module */
-
-Server *Srv;
+/* $ModDesc: Allow/Deny connections based upon an arbitary SQL table */
+/* $ModDep: m_sqlv2.h m_sqlutils.h m_hash.h */
class ModuleSQLAuth : public Module
{
- ConfigReader* Conf;
- std::string usertable;
- unsigned long dbid;
- Module* SQLModule;
+ Module* SQLutils;
+ Module* SQLprovider;
+
+ std::string freeformquery;
+ std::string killreason;
+ std::string allowpattern;
+ std::string databaseid;
- public:
- bool ReadConfig()
+ bool verbose;
+
+public:
+ ModuleSQLAuth(InspIRCd* Me)
+ : Module(Me)
{
- Conf = new ConfigReader();
- usertable = Conf->ReadValue("sqlauth","usertable",0);
- dbid = Conf->ReadInteger("sqlauth","dbid",0,true);
- delete Conf;
- SQLModule = Srv->FindModule("m_sql.so");
- return (SQLModule);
+ ServerInstance->Modules->UseInterface("SQLutils");
+ ServerInstance->Modules->UseInterface("SQL");
+
+ SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
+ if (!SQLutils)
+ throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqlauth.so.");
+
+ SQLprovider = ServerInstance->Modules->FindFeature("SQL");
+ if (!SQLprovider)
+ throw ModuleException("Can't find an SQL provider module. Please load one before attempting to load m_sqlauth.");
+
+ OnRehash(NULL,"");
+ Implementation eventlist[] = { I_OnUserDisconnect, I_OnCheckReady, I_OnRequest, I_OnRehash, I_OnUserRegister };
+ ServerInstance->Modules->Attach(eventlist, this, 5);
}
- ModuleSQLAuth()
+ virtual ~ModuleSQLAuth()
{
- Srv = new Server;
- ReadConfig();
+ ServerInstance->Modules->DoneWithInterface("SQL");
+ ServerInstance->Modules->DoneWithInterface("SQLutils");
}
- virtual void OnRehash()
+
+ virtual void OnRehash(User* user, const std::string ¶meter)
{
- ReadConfig();
+ ConfigReader Conf(ServerInstance);
+
+ databaseid = Conf.ReadValue("sqlauth", "dbid", 0); /* Database ID, given to the SQL service provider */
+ freeformquery = Conf.ReadValue("sqlauth", "query", 0); /* Field name where username can be found */
+ killreason = Conf.ReadValue("sqlauth", "killreason", 0); /* Reason to give when access is denied to a user (put your reg details here) */
+ allowpattern = Conf.ReadValue("sqlauth", "allowpattern",0 ); /* Allow nicks matching this pattern without requiring auth */
+ verbose = Conf.ReadFlag("sqlauth", "verbose", 0); /* Set to true if failed connects should be reported to operators */
}
- bool CheckCredentials(std::string username, std::string password,std::string usertable)
+ virtual int OnUserRegister(User* user)
{
- bool found = false;
+ if ((!allowpattern.empty()) && (InspIRCd::Match(user->nick,allowpattern)))
+ {
+ user->Extend("sqlauthed");
+ return 0;
+ }
- // is the sql module loaded? If not, we don't attempt to do anything.
- if (!SQLModule)
- return false;
+ if (!CheckCredentials(user))
+ {
+ ServerInstance->Users->QuitUser(user, killreason);
+ return 1;
+ }
+ return 0;
+ }
+
+ void SearchAndReplace(std::string& newline, const std::string &find, const std::string &replace)
+ {
+ std::string::size_type x = newline.find(find);
+ while (x != std::string::npos)
+ {
+ newline.erase(x, find.length());
+ if (!replace.empty())
+ newline.insert(x, replace);
+ x = newline.find(find);
+ }
+ }
+
+ bool CheckCredentials(User* user)
+ {
+ std::string thisquery = freeformquery;
+ std::string safepass = user->password;
- // Create a request containing the SQL query and send it to m_sql.so
- SQLRequest* query = new SQLRequest(SQL_RESULT,1,"SELECT * FROM "+usertable+" WHERE user='"+username+"' AND pass=md5('"+password+"')");
- Request queryrequest((char*)query, this, SQLModule);
- SQLResult* result = (SQLResult*)queryrequest.Send();
+ /* Search and replace the escaped nick and escaped pass into the query */
- // Did we get "OK" as a result?
- if (result->GetType() == SQL_OK)
+ SearchAndReplace(safepass, "\"", "");
+
+ SearchAndReplace(thisquery, "$nick", user->nick);
+ SearchAndReplace(thisquery, "$pass", safepass);
+ SearchAndReplace(thisquery, "$host", user->host);
+ SearchAndReplace(thisquery, "$ip", user->GetIPString());
+
+ Module* HashMod = ServerInstance->Modules->Find("m_md5.so");
+
+ if (HashMod)
+ {
+ HashResetRequest(this, HashMod).Send();
+ SearchAndReplace(thisquery, "$md5pass", HashSumRequest(this, HashMod, user->password).Send());
+ }
+
+ HashMod = ServerInstance->Modules->Find("m_sha256.so");
+
+ if (HashMod)
{
+ HashResetRequest(this, HashMod).Send();
+ SearchAndReplace(thisquery, "$sha256pass", HashSumRequest(this, HashMod, user->password).Send());
+ }
- // if we did, this means we may now request a row... there should be only one row for each user, so,
- // we don't need to loop to fetch multiple rows.
- SQLRequest* rowrequest = new SQLRequest(SQL_ROW,1,"");
- Request rowquery((char*)rowrequest, this, SQLModule);
- SQLResult* rowresult = (SQLResult*)rowquery.Send();
+ /* Build the query */
+ SQLrequest req = SQLrequest(this, SQLprovider, databaseid, SQLquery(thisquery));
- // did we get a row? If we did, we can now do something with the fields
- if (rowresult->GetType() == SQL_ROW)
+ if(req.Send())
+ {
+ /* When we get the query response from the service provider we will be given an ID to play with,
+ * just an ID number which is unique to this query. We need a way of associating that ID with a User
+ * so we insert it into a map mapping the IDs to users.
+ * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
+ * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
+ * us to discard the query.
+ */
+ AssociateUser(this, SQLutils, req.id, user).Send();
+
+ return true;
+ }
+ else
+ {
+ if (verbose)
+ ServerInstance->SNO->WriteToSnoMask('A', "Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick.c_str(), user->ident.c_str(), user->host.c_str(), req.error.Str());
+ return false;
+ }
+ }
+
+ virtual const char* OnRequest(Request* request)
+ {
+ if(strcmp(SQLRESID, request->GetId()) == 0)
+ {
+ SQLresult* res = static_cast<SQLresult*>(request);
+
+ User* user = GetAssocUser(this, SQLutils, res->id).S().user;
+ UnAssociate(this, SQLutils, res->id).S();
+
+ if(user)
{
- Srv->Log(DEBUG,"*********** SQL TEST MODULE - RESULTS *************");
- Srv->Log(DEBUG,"Result, field 'qcount': '" + rowrequest->GetField("qcount"));
- Srv->Log(DEBUG,"Result, field 'asked': '" + rowrequest->GetField("asked"));
- found = true;
- delete rowresult;
+ if(res->error.Id() == SQL_NO_ERROR)
+ {
+ if(res->Rows())
+ {
+ /* We got a row in the result, this is enough really */
+ user->Extend("sqlauthed");
+ }
+ else if (verbose)
+ {
+ /* No rows in result, this means there was no record matching the user */
+ ServerInstance->SNO->WriteToSnoMask('A', "Forbidden connection from %s!%s@%s (SQL query returned no matches)", user->nick.c_str(), user->ident.c_str(), user->host.c_str());
+ user->Extend("sqlauth_failed");
+ }
+ }
+ else if (verbose)
+ {
+ ServerInstance->SNO->WriteToSnoMask('A', "Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick.c_str(), user->ident.c_str(), user->host.c_str(), res->error.Str());
+ user->Extend("sqlauth_failed");
+ }
}
else
{
- // we didn't have a row.
- found = false;
+ return NULL;
}
- delete rowrequest;
- delete result;
- }
- else
- {
- // the query was bad
- found = false;
+
+ if (!user->GetExt("sqlauthed"))
+ {
+ ServerInstance->Users->QuitUser(user, killreason);
+ }
+ return SQLSUCCESS;
}
- query->SetQueryType(SQL_DONE);
- query->SetConnID(1);
- Request donerequest((char*)query, this, SQLModule);
- donerequest.Send();
- delete query;
- return found;
+ return NULL;
}
- virtual bool OnCheckReady(userrec* user)
+ virtual void OnUserDisconnect(User* user)
{
+ user->Shrink("sqlauthed");
+ user->Shrink("sqlauth_failed");
}
- virtual void OnUserDisconnect(userrec* user)
- {
- }
-
- virtual ~ModuleSQLAuth()
+ virtual bool OnCheckReady(User* user)
{
- delete Srv;
+ return user->GetExt("sqlauthed");
}
-
+
virtual Version GetVersion()
{
- return Version(1,0,0,1,VF_VENDOR);
+ return Version("$Id$", VF_VENDOR, API_VERSION);
}
-
-};
-class ModuleSQLAuthFactory : public ModuleFactory
-{
- public:
- ModuleSQLAuthFactory()
- {
- }
-
- ~ModuleSQLAuthFactory()
- {
- }
-
- virtual Module * CreateModule()
- {
- return new ModuleSQLAuth;
- }
-
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleSQLAuthFactory;
-}
-
+MODULE_INIT(ModuleSQLAuth)