* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd 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-2007 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.
*
* ---------------------------------------------------
*/
-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 "inspircd.h"
#include "users.h"
#include "channels.h"
#include "modules.h"
-#include "inspircd.h"
-#include "helperfuncs.h"
-#include "m_sql.h"
+#include "m_sqlv2.h"
+#include "m_sqlutils.h"
/* $ModDesc: Allow/Deny connections based upon an arbitary SQL table */
+/* $ModDep: m_sqlv2.h m_sqlutils.h */
class ModuleSQLAuth : public Module
{
- Server* Srv;
- ConfigReader* Conf;
+ Module* SQLutils;
+ Module* SQLprovider;
+
std::string usertable;
std::string userfield;
std::string passfield;
std::string encryption;
std::string killreason;
std::string allowpattern;
- bool WallOperFail;
- unsigned long dbid;
- Module* SQLModule;
-
- public:
- bool ReadConfig()
+ std::string databaseid;
+
+ bool verbose;
+
+public:
+ ModuleSQLAuth(InspIRCd* Me)
+ : Module::Module(Me)
{
- Conf = new ConfigReader();
- usertable = Conf->ReadValue("sqlauth","usertable",0); // user table name
- dbid = Conf->ReadInteger("sqlauth","dbid",0,true); // database id of a database configured in m_sql (see m_sql config)
- userfield = Conf->ReadValue("sqlauth","userfield",0); // field name where username can be found
- passfield = Conf->ReadValue("sqlauth","passfield",0); // field name where password can be found
- killreason = Conf->ReadValue("sqlauth","killreason",0); // reason to give when access is denied to a user (put your reg details here)
- encryption = Conf->ReadValue("sqlauth","encryption",0); // name of sql function used to encrypt password, e.g. "md5" or "passwd".
- // define, but leave blank if no encryption is to be used.
- WallOperFail = Conf->ReadFlag("sqlauth","verbose",0); // set to 1 if failed connects should be reported to operators
- allowpattern = Conf->ReadValue("sqlauth","allowpattern",0); // allow nicks matching the pattern without requiring auth
- if (encryption.find("(") == std::string::npos)
- {
- encryption.append("(");
- }
- delete Conf;
- SQLModule = Srv->FindModule("m_sql.so");
- if (!SQLModule)
- Srv->Log(DEFAULT,"WARNING: m_sqlauth.so could not initialize because m_sql.so is not loaded. Load the module and rehash your server.");
- 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,"");
}
- ModuleSQLAuth(Server* Me)
- : Module::Module(Me)
+ virtual ~ModuleSQLAuth()
{
- Srv = Me;
- ReadConfig();
+ ServerInstance->Modules->DoneWithInterface("SQL");
+ ServerInstance->Modules->DoneWithInterface("SQLutils");
}
void Implements(char* List)
{
- List[I_OnRehash] = List[I_OnUserRegister] = 1;
+ List[I_OnUserDisconnect] = List[I_OnCheckReady] = List[I_OnRequest] = List[I_OnRehash] = List[I_OnUserRegister] = 1;
}
- virtual void OnRehash(const std::string ¶meter)
+ virtual void OnRehash(User* user, const std::string ¶meter)
{
- ReadConfig();
- }
+ ConfigReader Conf(ServerInstance);
+
+ usertable = Conf.ReadValue("sqlauth", "usertable", 0); /* User table name */
+ databaseid = Conf.ReadValue("sqlauth", "dbid", 0); /* Database ID, given to the SQL service provider */
+ userfield = Conf.ReadValue("sqlauth", "userfield", 0); /* Field name where username can be found */
+ passfield = Conf.ReadValue("sqlauth", "passfield", 0); /* Field name where password 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 */
+ encryption = Conf.ReadValue("sqlauth", "encryption", 0); /* Name of sql function used to encrypt password, e.g. "md5" or "passwd".
+ * define, but leave blank if no encryption is to be used.
+ */
+ verbose = Conf.ReadFlag("sqlauth", "verbose", 0); /* Set to true if failed connects should be reported to operators */
+
+ if (encryption.find("(") == std::string::npos)
+ {
+ encryption.append("(");
+ }
+ }
- virtual void OnUserRegister(userrec* user)
+ virtual int OnUserRegister(User* user)
{
- if ((allowpattern != "") && (Srv->MatchText(user->nick,allowpattern)))
- return;
+ if ((!allowpattern.empty()) && (ServerInstance->MatchText(user->nick,allowpattern)))
+ {
+ user->Extend("sqlauthed");
+ return 0;
+ }
- if (!CheckCredentials(user->nick,user->password))
+ if (!CheckCredentials(user))
{
- if (WallOperFail)
- WriteOpers("Forbidden connection from %s!%s@%s (invalid login/password)",user->nick,user->ident,user->host);
- Srv->QuitUser(user,killreason);
+ User::QuitUser(ServerInstance,user,killreason);
+ return 1;
}
+ return 0;
}
- bool CheckCredentials(const std::string &username, const std::string &password)
+ bool CheckCredentials(User* user)
{
- bool found = false;
-
- // is the sql module loaded? If not, we don't attempt to do anything.
- if (!SQLModule)
- return false;
-
- // sanitize the password (we dont want any mysql insertion exploits!)
- std::string temp = "";
- for (unsigned int q = 0; q < password.length(); q++)
+ SQLrequest req = SQLreq(this, SQLprovider, databaseid, "SELECT ? FROM ? WHERE ? = '?' AND ? = ?'?')", userfield, usertable, userfield, user->nick, passfield, encryption, user->password);
+
+ if(req.Send())
{
- if (password[q] == '\'')
- {
- temp = temp + "\'";
- }
- else if (password[q] == '"')
- {
- temp = temp + "\\\"";
- }
- else temp = temp + password[q];
+ /* 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;
}
- password = temp;
-
- // Create a request containing the SQL query and send it to m_sql.so
- std::string querystr("SELECT * FROM "+usertable+" WHERE "+userfield+"='"+username+"' AND "+passfield+"="+encryption+"'"+password+"')");
-
- Srv->Log(DEBUG, "m_sqlauth.so: Query: " + querystr);
-
- SQLRequest* query = new SQLRequest(SQL_RESULT,dbid,querystr);
- Request queryrequest((char*)query, this, SQLModule);
- SQLResult* result = (SQLResult*)queryrequest.Send();
-
- // Did we get "OK" as a result?
- if (result->GetType() == SQL_OK)
+ else
+ {
+ if (verbose)
+ ServerInstance->WriteOpers("Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick, user->ident, user->host, req.error.Str());
+ return false;
+ }
+ }
+
+ virtual char* OnRequest(Request* request)
+ {
+ if(strcmp(SQLRESID, request->GetId()) == 0)
{
- log(DEBUG, "m_sqlauth.so: Query OK");
+ SQLresult* res = static_cast<SQLresult*>(request);
+
+ User* user = GetAssocUser(this, SQLutils, res->id).S().user;
+ UnAssociate(this, SQLutils, res->id).S();
- // 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,dbid,"");
- Request rowquery((char*)rowrequest, this, SQLModule);
- SQLResult* rowresult = (SQLResult*)rowquery.Send();
-
- // did we get a row? If we did, we can now do something with the fields
- if (rowresult->GetType() == SQL_ROW)
+ if(user)
{
- log(DEBUG, "m_sqlauth.so: Got row...user '%s'", rowresult->GetField(userfield).c_str());
-
- if (rowresult->GetField(userfield) == username)
+ if(res->error.Id() == NO_ERROR)
{
- log(DEBUG, "m_sqlauth.so: Got correct user...");
- // because the query directly asked for the password hash, we do not need to check it -
- // if it didnt match it wont be returned in the first place from the SELECT.
- // This just checks we didnt get an empty row by accident.
- found = true;
+ 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->WriteOpers("Forbidden connection from %s!%s@%s (SQL query returned no matches)", user->nick, user->ident, user->host);
+ user->Extend("sqlauth_failed");
+ }
+ }
+ else if (verbose)
+ {
+ ServerInstance->WriteOpers("Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick, user->ident, user->host, res->error.Str());
+ user->Extend("sqlauth_failed");
}
}
else
{
- log(DEBUG, "m_sqlauth.so: Couldn't find row");
- // we didn't have a row.
- found = false;
+ return NULL;
}
-
- delete rowrequest;
- delete rowresult;
- }
- else
- {
- log(DEBUG, "m_sqlauth.so: Query failed");
- // the query was bad
- found = false;
- }
-
- query->SetQueryType(SQL_DONE);
- query->SetConnID(dbid);
- Request donerequest((char*)query, this, SQLModule);
- donerequest.Send();
-
- delete query;
- delete result;
-
- return found;
- }
- virtual ~ModuleSQLAuth()
- {
- }
-
- virtual Version GetVersion()
- {
- return Version(1,0,0,2,VF_VENDOR);
+ if (!user->GetExt("sqlauthed"))
+ {
+ User::QuitUser(ServerInstance,user,killreason);
+ }
+ return SQLSUCCESS;
+ }
+ return NULL;
}
-};
-
-class ModuleSQLAuthFactory : public ModuleFactory
-{
- public:
- ModuleSQLAuthFactory()
+ virtual void OnUserDisconnect(User* user)
{
+ user->Shrink("sqlauthed");
+ user->Shrink("sqlauth_failed");
}
- ~ModuleSQLAuthFactory()
+ virtual bool OnCheckReady(User* user)
{
+ return user->GetExt("sqlauthed");
}
-
- virtual Module * CreateModule(Server* Me)
+
+ virtual Version GetVersion()
{
- return new ModuleSQLAuth(Me);
+ return Version(1,1,1,0,VF_VENDOR,API_VERSION);
}
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleSQLAuthFactory;
-}
-
+MODULE_INIT(ModuleSQLAuth)